Package com.oracle.bmc.gdp.model

Class GdpPipelineSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230301")
public final class GdpPipelineSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Retrieves summary pipeline configuration information by identifier.
    Note: Objects should always be created or deserialized using the GdpPipelineSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the GdpPipelineSummary.Builder, which maintain a set of all explicitly set fields called GdpPipelineSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the pipeline.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Pipeline short name.
        Returns:
        the value

      • getDescription

        public String getDescription()
        Short field input by customer for a description of the data pipeline use-case.
        Returns:
        the value

      • getServiceLogGroupId

        public String getServiceLogGroupId()
        the OCID of the service log group.
        Returns:
        the value

      • getPipelineType

        public GdpPipeline.PipelineType getPipelineType()
        Type of pipeline.

        Can be SENDER or RECEIVER.

        Returns:
        the value

      • getPeeringRegion

        public String getPeeringRegion()
        Public region name where the peered pipeline exists.
        Returns:
        the value

      • getAuthorizationDetails

        public String getAuthorizationDetails()
        Free-text field containing tracking information for approval tracking.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the pipeline was created.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the pipeline was updated.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getIsFileOverrideInDestinationEnabled

        public Boolean getIsFileOverrideInDestinationEnabled()
        Enable file override feature in destination bucket
        Returns:
        the value

      • getIsScanningEnabled

        public Boolean getIsScanningEnabled()
        Determines whether GDP Scanning should be enabled for the pipeline.
        Returns:
        the value

      • getIsChunkingEnabled

        public Boolean getIsChunkingEnabled()
        Determines whether file must be chunked during the transfer.

        This is only a property of SENDER pipelines.

        Returns:
        the value

      • getIsApprovalNeeded

        public Boolean getIsApprovalNeeded()
        Determines whether file transfers need to go through an approval workflow.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel