Class GdpPipeline

Retrieves pipeline configuration information by identifier.

Inheritance

object

GdpPipeline

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GdpService.Models

Assembly: OCI.DotNetSDK.Gdp.dll

Syntax

public class GdpPipeline

Properties

ApprovalKeyVaultId

Declaration

[JsonProperty(PropertyName = "approvalKeyVaultId")]
public string ApprovalKeyVaultId { get; set; }

Property Value

Type	Description
string	The KMS vault OCID for the key to be used for file transfer approvals.

AuthorizationDetails

Declaration

[JsonProperty(PropertyName = "authorizationDetails")]
public string AuthorizationDetails { get; set; }

Property Value

Type	Description
string	Authorization information about the pipeline being configured.

BucketDetails

Declaration

[JsonProperty(PropertyName = "bucketDetails")]
public List<BucketDetailsDefinition> BucketDetails { get; set; }

Property Value

Type	Description
List<BucketDetailsDefinition>	Information about the bucket in the pipeline being configured.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

DefinedTags

Declaration

[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Remarks

Required

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Short field input by customer for a description of the data pipeline use-case.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	Pipeline short name.

Remarks

Required

FileTypes

Declaration

[JsonProperty(PropertyName = "fileTypes")]
public List<string> FileTypes { get; set; }

Property Value

Type	Description
List<string>	List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc).

FreeformTags

Declaration

[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the pipeline.

Remarks

Required

IsApprovalNeeded

Declaration

[JsonProperty(PropertyName = "isApprovalNeeded")]
public bool? IsApprovalNeeded { get; set; }

Property Value

Type	Description
bool?	Determines whether file transfers need to go through an approval workflow.

IsChunkingEnabled

Declaration

[JsonProperty(PropertyName = "isChunkingEnabled")]
public bool? IsChunkingEnabled { get; set; }

Property Value

Type	Description
bool?	Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.

IsFileOverrideInDestinationEnabled

Declaration

[JsonProperty(PropertyName = "isFileOverrideInDestinationEnabled")]
public bool? IsFileOverrideInDestinationEnabled { get; set; }

Property Value

Type	Description
bool?	Enable file override feature in destination bucket

IsScanningEnabled

Declaration

[JsonProperty(PropertyName = "isScanningEnabled")]
public bool? IsScanningEnabled { get; set; }

Property Value

Type	Description
bool?	Determines whether GDP Scanning should be enabled for the pipeline.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional details about the current state of the pipeline.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public GdpPipeline.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
GdpPipeline.LifecycleStateEnum?	The current state of the pipeline.

Remarks

Required

PeeredGdpPipelineId

Declaration

[JsonProperty(PropertyName = "peeredGdpPipelineId")]
public string PeeredGdpPipelineId { get; set; }

Property Value

Type	Description
string	OCID of the peered pipeline.

PeeringRegion

Declaration

[Required(ErrorMessage = "PeeringRegion is required.")]
[JsonProperty(PropertyName = "peeringRegion")]
public string PeeringRegion { get; set; }

Property Value

Type	Description
string	Public region name where the peered pipeline exists.

Remarks

Required

PipelineType

Declaration

[Required(ErrorMessage = "PipelineType is required.")]
[JsonProperty(PropertyName = "pipelineType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public GdpPipeline.PipelineTypeEnum? PipelineType { get; set; }

Property Value

Type	Description
GdpPipeline.PipelineTypeEnum?	Type of pipeline. Can be SENDER or RECEIVER.

Remarks

Required

ServiceLogGroupId

Declaration

[JsonProperty(PropertyName = "serviceLogGroupId")]
public string ServiceLogGroupId { get; set; }

Property Value

Type	Description
string	the OCID of the service log group.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the the pipeline was created. An RFC3339 formatted datetime string.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the pipeline was updated. An RFC3339 formatted datetime string.

Remarks

Required