Package io.camunda.zeebe.protocol.record.value

Class ImmutableDeploymentRecordValue

java.lang.Object
io.camunda.zeebe.protocol.record.value.ImmutableDeploymentRecordValue
All Implemented Interfaces:
JsonSerializable, RecordValue, DeploymentRecordValue, TenantOwned
public final class ImmutableDeploymentRecordValue extends Object implements DeploymentRecordValue
Immutable implementation of DeploymentRecordValue.

Use the builder to create immutable instances: ImmutableDeploymentRecordValue.builder().

  • Method Details

    • getTenantId

      public String getTenantId()
      Returns the identifier of the tenant that owns this entity.
      Specified by:
      getTenantId in interface TenantOwned

    • getResources

      public List<DeploymentResource> getResources()
      Specified by:
      getResources in interface DeploymentRecordValue
      Returns:
      the resources to deploy

    • getProcessesMetadata

      public List<ProcessMetadataValue> getProcessesMetadata()
      Specified by:
      getProcessesMetadata in interface DeploymentRecordValue
      Returns:
      the deployed processes

    • getDecisionsMetadata

      public List<DecisionRecordValue> getDecisionsMetadata()
      Specified by:
      getDecisionsMetadata in interface DeploymentRecordValue
      Returns:
      the deployed decisions

    • getDecisionRequirementsMetadata

      public List<DecisionRequirementsMetadataValue> getDecisionRequirementsMetadata()
      Specified by:
      getDecisionRequirementsMetadata in interface DeploymentRecordValue
      Returns:
      the deployed decision requirements (DRGs)

    • getFormMetadata

      public List<FormMetadataValue> getFormMetadata()
      Specified by:
      getFormMetadata in interface DeploymentRecordValue
      Returns:
      the deployed forms

    • getDeploymentKey

      public long getDeploymentKey()
      Specified by:
      getDeploymentKey in interface DeploymentRecordValue
      Returns:
      the unique key of the deployment

    • withTenantId

      public final ImmutableDeploymentRecordValue withTenantId(String value)
      Copy the current immutable object by setting a value for the tenantId attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for tenantId (can be null)
      Returns:
      A modified copy of the this object

    • withResources

      public final ImmutableDeploymentRecordValue withResources(DeploymentResource... elements)
      Copy the current immutable object with elements that replace the content of resources.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withResources

      public final ImmutableDeploymentRecordValue withResources(Iterable<? extends DeploymentResource> elements)
      Copy the current immutable object with elements that replace the content of resources. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of resources elements to set
      Returns:
      A modified copy of this object

    • withProcessesMetadata

      public final ImmutableDeploymentRecordValue withProcessesMetadata(ProcessMetadataValue... elements)
      Copy the current immutable object with elements that replace the content of processesMetadata.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withProcessesMetadata

      public final ImmutableDeploymentRecordValue withProcessesMetadata(Iterable<? extends ProcessMetadataValue> elements)
      Copy the current immutable object with elements that replace the content of processesMetadata. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of processesMetadata elements to set
      Returns:
      A modified copy of this object

    • withDecisionsMetadata

      public final ImmutableDeploymentRecordValue withDecisionsMetadata(DecisionRecordValue... elements)
      Copy the current immutable object with elements that replace the content of decisionsMetadata.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withDecisionsMetadata

      public final ImmutableDeploymentRecordValue withDecisionsMetadata(Iterable<? extends DecisionRecordValue> elements)
      Copy the current immutable object with elements that replace the content of decisionsMetadata. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of decisionsMetadata elements to set
      Returns:
      A modified copy of this object

    • withDecisionRequirementsMetadata

      public final ImmutableDeploymentRecordValue withDecisionRequirementsMetadata(DecisionRequirementsMetadataValue... elements)
      Copy the current immutable object with elements that replace the content of decisionRequirementsMetadata.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withDecisionRequirementsMetadata

      public final ImmutableDeploymentRecordValue withDecisionRequirementsMetadata(Iterable<? extends DecisionRequirementsMetadataValue> elements)
      Copy the current immutable object with elements that replace the content of decisionRequirementsMetadata. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of decisionRequirementsMetadata elements to set
      Returns:
      A modified copy of this object

    • withFormMetadata

      public final ImmutableDeploymentRecordValue withFormMetadata(FormMetadataValue... elements)
      Copy the current immutable object with elements that replace the content of formMetadata.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withFormMetadata

      public final ImmutableDeploymentRecordValue withFormMetadata(Iterable<? extends FormMetadataValue> elements)
      Copy the current immutable object with elements that replace the content of formMetadata. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of formMetadata elements to set
      Returns:
      A modified copy of this object

    • withDeploymentKey

      public final ImmutableDeploymentRecordValue withDeploymentKey(long value)
      Copy the current immutable object by setting a value for the deploymentKey attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for deploymentKey
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of ImmutableDeploymentRecordValue that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Returns a lazily computed hash code from attributes: tenantId, resources, processesMetadata, decisionsMetadata, decisionRequirementsMetadata, formMetadata, deploymentKey.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value DeploymentRecordValue with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableDeploymentRecordValue copyOf(DeploymentRecordValue instance)
      Creates an immutable copy of a DeploymentRecordValue value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable DeploymentRecordValue instance

    • builder

      public static ImmutableDeploymentRecordValue.Builder builder()
      Creates a builder for ImmutableDeploymentRecordValue. 
       ImmutableDeploymentRecordValue.builder()
    .withTenantId(String | null) // nullable tenantId
    .addResource|addAllResources(io.camunda.zeebe.protocol.record.value.deployment.DeploymentResource) // resources elements
    .addProcessesMetadata|addAllProcessesMetadata(io.camunda.zeebe.protocol.record.value.deployment.ProcessMetadataValue) // processesMetadata elements
    .addDecisionsMetadata|addAllDecisionsMetadata(io.camunda.zeebe.protocol.record.value.deployment.DecisionRecordValue) // decisionsMetadata elements
    .addDecisionRequirementsMetadata|addAllDecisionRequirementsMetadata(io.camunda.zeebe.protocol.record.value.deployment.DecisionRequirementsMetadataValue) // decisionRequirementsMetadata elements
    .addFormMetadata|addAllFormMetadata(io.camunda.zeebe.protocol.record.value.deployment.FormMetadataValue) // formMetadata elements
    .withDeploymentKey(long) // optional deploymentKey
    .build();
      Returns:
      A new ImmutableDeploymentRecordValue builder