Class FlowStartContext.Builder

  • All Implemented Interfaces:
    org.apache.avro.data.RecordBuilder

    
    public class FlowStartContext.Builder
    extends SpecificRecordBuilderBase<T> implements RecordBuilder<T>
                        

    RecordBuilder for FlowStartContext instances.

    • Constructor Detail

    • Method Detail

      • getStatusKey

         FlowKey getStatusKey()

        Gets the value of the 'statusKey' field. The unique ID for tracking the flow status

      • getStatusKeyBuilder

         FlowKey.Builder getStatusKeyBuilder()

        Gets the Builder instance for the 'statusKey' field and creates one if it doesn't exist yet. The unique ID for tracking the flow status

      • getRequestId

         String getRequestId()

        Gets the value of the 'requestId' field. The request ID assigned by the client or session that created the flow.

      • setRequestId

         FlowStartContext.Builder setRequestId(String value)

        Sets the value of the 'requestId' field. The request ID assigned by the client or session that created the flow.

        Parameters:
        value - The value of 'requestId'.
      • getCpiId

         String getCpiId()

        Gets the value of the 'cpiId' field. The CPI ID for the package containing the flow.

      • getFlowClassName

         String getFlowClassName()

        Gets the value of the 'flowClassName' field. The fully qualified class name of the flow.

      • getStartArgs

         String getStartArgs()

        Gets the value of the 'startArgs' field. The body of the request provided when the flow was started if this flow was started via RPC. Null otherwise.

      • setStartArgs

         FlowStartContext.Builder setStartArgs(String value)

        Sets the value of the 'startArgs' field. The body of the request provided when the flow was started if this flow was started via RPC. Null otherwise.

        Parameters:
        value - The value of 'startArgs'.
      • getContextPlatformProperties

         KeyValuePairList getContextPlatformProperties()

        Gets the value of the 'contextPlatformProperties' field. A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context. Only populated if this flow was started via RPC. Empty otherwise.

      • setContextPlatformProperties

         FlowStartContext.Builder setContextPlatformProperties(KeyValuePairList value)

        Sets the value of the 'contextPlatformProperties' field. A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context. Only populated if this flow was started via RPC. Empty otherwise.

        Parameters:
        value - The value of 'contextPlatformProperties'.
      • getContextPlatformPropertiesBuilder

         KeyValuePairList.Builder getContextPlatformPropertiesBuilder()

        Gets the Builder instance for the 'contextPlatformProperties' field and creates one if it doesn't exist yet. A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context. Only populated if this flow was started via RPC. Empty otherwise.

      • setContextPlatformPropertiesBuilder

         FlowStartContext.Builder setContextPlatformPropertiesBuilder(KeyValuePairList.Builder value)

        Sets the Builder instance for the 'contextPlatformProperties' field A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context. Only populated if this flow was started via RPC. Empty otherwise.

        Parameters:
        value - The builder instance that must be set.
      • getCreatedTimestamp

         Instant getCreatedTimestamp()

        Gets the value of the 'createdTimestamp' field. The date and time the flow was created.

      • hasStatusKey

         boolean hasStatusKey()

        Checks whether the 'statusKey' field has been set. The unique ID for tracking the flow status

      • hasStatusKeyBuilder

         boolean hasStatusKeyBuilder()

        Checks whether the 'statusKey' field has an active Builder instance The unique ID for tracking the flow status

      • hasInitiatorType

         boolean hasInitiatorType()

        Checks whether the 'initiatorType' field has been set. The type of initiator that started the flow

      • hasRequestId

         boolean hasRequestId()

        Checks whether the 'requestId' field has been set. The request ID assigned by the client or session that created the flow.

      • hasIdentity

         boolean hasIdentity()

        Checks whether the 'identity' field has been set. The identity of the party executing the flow.

      • hasIdentityBuilder

         boolean hasIdentityBuilder()

        Checks whether the 'identity' field has an active Builder instance The identity of the party executing the flow.

      • hasCpiId

         boolean hasCpiId()

        Checks whether the 'cpiId' field has been set. The CPI ID for the package containing the flow.

      • hasInitiatedBy

         boolean hasInitiatedBy()

        Checks whether the 'initiatedBy' field has been set. The identity of the party that initiated the flow.

      • hasInitiatedByBuilder

         boolean hasInitiatedByBuilder()

        Checks whether the 'initiatedBy' field has an active Builder instance The identity of the party that initiated the flow.

      • hasFlowClassName

         boolean hasFlowClassName()

        Checks whether the 'flowClassName' field has been set. The fully qualified class name of the flow.

      • hasStartArgs

         boolean hasStartArgs()

        Checks whether the 'startArgs' field has been set. The body of the request provided when the flow was started if this flow was started via RPC. Null otherwise.

      • clearStartArgs

         FlowStartContext.Builder clearStartArgs()

        Clears the value of the 'startArgs' field. The body of the request provided when the flow was started if this flow was started via RPC. Null otherwise.

      • hasContextPlatformProperties

         boolean hasContextPlatformProperties()

        Checks whether the 'contextPlatformProperties' field has been set. A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context. Only populated if this flow was started via RPC. Empty otherwise.

      • hasContextPlatformPropertiesBuilder

         boolean hasContextPlatformPropertiesBuilder()

        Checks whether the 'contextPlatformProperties' field has an active Builder instance A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context. Only populated if this flow was started via RPC. Empty otherwise.

      • clearContextPlatformProperties

         FlowStartContext.Builder clearContextPlatformProperties()

        Clears the value of the 'contextPlatformProperties' field. A map of platform context properties made available to the flow which will also be propagated to sub flows, initiated flows and services, associating the entire end to end flow execution path with a notion of a context. Only populated if this flow was started via RPC. Empty otherwise.

      • hasCreatedTimestamp

         boolean hasCreatedTimestamp()

        Checks whether the 'createdTimestamp' field has been set. The date and time the flow was created.