Package com.google.cloud.eventarc.v1

Interface PipelineOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Pipeline, Pipeline.Builder
@Generated public interface PipelineOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String 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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • hasCreateTime

      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:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.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:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.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];

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.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:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.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];

    • getLabelsCount

      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];

    • containsLabels

      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];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      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 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];

    • getLabelsOrThrow

      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];

    • getUid

      String 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:
      The uid.

    • getUidBytes

      com.google.protobuf.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:
      The bytes for uid.

    • getAnnotationsCount

      int getAnnotationsCount()
       Optional. User-defined annotations. See
 https://google.aip.dev/128#annotations.
      map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

    • containsAnnotations

      boolean containsAnnotations(String key)
       Optional. User-defined annotations. See
 https://google.aip.dev/128#annotations.
      map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotations

      @Deprecated Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.

    • getAnnotationsMap

      Map<String,String> getAnnotationsMap()
       Optional. User-defined annotations. See
 https://google.aip.dev/128#annotations.
      map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrDefault

      String getAnnotationsOrDefault(String key, String defaultValue)
       Optional. User-defined annotations. See
 https://google.aip.dev/128#annotations.
      map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrThrow

      String getAnnotationsOrThrow(String key)
       Optional. User-defined annotations. See
 https://google.aip.dev/128#annotations.
      map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getDisplayName

      String getDisplayName()
       Optional. Display name of resource.
      string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. Display name of resource.
      string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for displayName.

    • getDestinationsList

      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];

    • getDestinations

      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];

    • getDestinationsCount

      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];

    • getDestinationsOrBuilderList

      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];

    • getDestinationsOrBuilder

      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];

    • getMediationsList

      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];

    • getMediations

      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];

    • getMediationsCount

      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];

    • getMediationsOrBuilderList

      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];

    • getMediationsOrBuilder

      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];

    • getCryptoKeyName

      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:
      The cryptoKeyName.

    • getCryptoKeyNameBytes

      com.google.protobuf.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:
      The bytes for cryptoKeyName.

    • hasInputPayloadFormat

      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:
      Whether the inputPayloadFormat field is set.

    • getInputPayloadFormat

      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];
      Returns:
      The inputPayloadFormat.

    • getInputPayloadFormatOrBuilder

      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];

    • hasLoggingConfig

      boolean hasLoggingConfig()
       Optional. Config to control Platform Logging for Pipelines.
      .google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the loggingConfig field is set.

    • getLoggingConfig

      LoggingConfig getLoggingConfig()
       Optional. Config to control Platform Logging for Pipelines.
      .google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The loggingConfig.

    • getLoggingConfigOrBuilder

      LoggingConfigOrBuilder getLoggingConfigOrBuilder()
       Optional. Config to control Platform Logging for Pipelines.
      .google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL];

    • hasRetryPolicy

      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:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      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];
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      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];

    • getEtag

      String 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The etag.

    • getEtagBytes

      com.google.protobuf.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 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for etag.

    • getSatisfiesPzs

      boolean getSatisfiesPzs()
       Output only. Whether or not this Pipeline satisfies the requirements of
 physical zone separation
      bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzs.