Add list services (#391)

Author: fivetran-aleksandrboldyrev

CHANGELOG.md

@@ -5,9 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.4.2...HEAD)
+## [Unreleased](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.5.0...HEAD)
 
-## [1.4.1](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.4.1...v1.4.2)
+## [1.5.0](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.4.2...v1.5.0)
+
+- New data source `fivetran_connectors` that allows to retrieve the list of existing Connections available for the current account.
+- New data source `fivetran_destinations` that allows to retrieve the list of existing Destinations available for the current account.
+- New data source `fivetran_external_logs` that allows to retrieve the list of existing External Logging Services available for the current account.
+
+## [1.4.2](https://github.com/fivetran/terraform-provider-fivetran/compare/v1.4.1...v1.4.2)
 
 ## Added
 - Add `is_primary_key` to connector schema config

docs/data-sources/connectors.md

@@ -0,0 +1,50 @@
+---
+page_title: "Data Source: fivetran_connectors"
+---
+
+# Data Source: fivetran_connectors
+
+This data source returns list of connector objects.
+
+## Example Usage
+
+```hcl
+data "fivetran_connectors" "connector" {
+    id = "anonymous_mystery"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `connectors` (Block Set) (see [below for nested schema](#nestedblock--connectors))
+- `id` (String) The ID of this resource.
+
+<a id="nestedblock--connectors"></a>
+### Nested Schema for `connectors`
+
+Read-Only:
+
+- `connected_by` (String) The unique identifier of the user who has created the connector in your account.
+- `created_at` (String) The timestamp of the time the connector was created in your account.
+- `daily_sync_time` (String) The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use [the baseline sync start time](https://fivetran.com/docs/getting-started/syncoverview#syncfrequencyandscheduling). This parameter has no effect on the [0 to 60 minutes offset](https://fivetran.com/docs/getting-started/syncoverview#syncstarttimesandoffsets) used to determine the actual sync start time.
+- `data_delay_sensitivity` (String) The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
+- `data_delay_threshold` (Number) Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data_delay_sensitivity set to CUSTOM.
+- `failed_at` (String) The timestamp of the time the connector sync failed last time.
+- `group_id` (String) The unique identifier for the Group (Destination) within the Fivetran system.
+- `hybrid_deployment_agent_id` (String) The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
+- `id` (String) The unique identifier for the connector within the Fivetran system.
+- `local_processing_agent_id` (String) (Deprecated) The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
+- `name` (String) The name used both as the connector's name within the Fivetran system and as the source schema's name within your destination.
+- `networking_method` (String) Possible values: Directly, SshTunnel, ProxyAgent.
+- `pause_after_trial` (Boolean) Specifies whether the connector should be paused after the free trial period has ended.
+- `paused` (Boolean) Specifies whether the connector is paused.
+- `private_link_id` (String) The private link ID.
+- `proxy_agent_id` (String) The proxy agent ID.
+- `schedule_type` (String) The connector schedule configuration type. Supported values: auto, manual.
+- `service` (String) The connector type id within the Fivetran system.
+- `service_version` (String) The connector type version within the Fivetran system.
+- `succeeded_at` (String) The timestamp of the time the connector sync succeeded last time.
+- `sync_frequency` (Number) The connector sync frequency in minutes.

docs/data-sources/destinations.md

@@ -0,0 +1,40 @@
+---
+page_title: "Data Source: fivetran_destinations"
+---
+
+# Data Source: fivetran_destinations
+
+This data source returns list of destination objects.
+
+## Example Usage
+
+```hcl
+data "fivetran_destinations" "dest" {
+    id = "anonymous_mystery"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `destinations` (Block Set) (see [below for nested schema](#nestedblock--destinations))
+- `id` (String) The ID of this resource.
+
+<a id="nestedblock--destinations"></a>
+### Nested Schema for `destinations`
+
+Read-Only:
+
+- `daylight_saving_time_enabled` (Boolean) Shift my UTC offset with daylight savings time (US Only)
+- `group_id` (String) The unique identifier for the Group within the Fivetran system.
+- `hybrid_deployment_agent_id` (String) The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
+- `id` (String) The unique identifier for the destination within the Fivetran system.
+- `local_processing_agent_id` (String) (Deprecated) The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
+- `networking_method` (String) Possible values: Directly, SshTunnel, ProxyAgent.
+- `private_link_id` (String) The private link ID.
+- `region` (String) Data processing location. This is where Fivetran will operate and run computation on data.
+- `service` (String) The destination type id within the Fivetran system.
+- `setup_status` (String) Destination setup status.
+- `time_zone_offset` (String) Determines the time zone for the Fivetran sync schedule.

docs/data-sources/external_logs.md

@@ -0,0 +1,32 @@
+---
+page_title: "Data Source: fivetran_external_logs"
+---
+
+# Data Source: fivetran_external_logs
+
+This data source returns list of logging service objects.
+
+## Example Usage
+
+```hcl
+data "fivetran_external_logs" "extlog" {
+    id = "anonymous_mystery"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `logs` (Block Set) (see [below for nested schema](#nestedblock--logs))
+
+<a id="nestedblock--logs"></a>
+### Nested Schema for `logs`
+
+Read-Only:
+
+- `enabled` (Boolean) The boolean value specifying whether the log service is enabled.
+- `id` (String) The unique identifier for the log service within the Fivetran system.
+- `service` (String) The name for the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, new_relic_log, splunkLog, stackdriver.

fivetran/framework/core/core.go

@@ -105,6 +105,16 @@ func (s Schema) GetDatasourceSchema() map[string]datasourceSchema.Attribute {
 	return result
 }
 
+func (s Schema) GetDatasourceListSchema() map[string]datasourceSchema.Attribute {
+	result := map[string]datasourceSchema.Attribute{}
+	for k, v := range s.Fields {
+		if !v.ResourceOnly {
+			result[k] = v.getDatasourceSchemaAttributeForList()
+		}
+	}
+	return result
+}
+
 func (s Schema) GetResourceSchema() map[string]resourceSchema.Attribute {
 	result := make(map[string]resourceSchema.Attribute)
 	for k, v := range s.Fields {
@@ -165,6 +175,50 @@ func (s SchemaField) getDatasourceSchemaAttribute() datasourceSchema.Attribute {
 	return result
 }
 
+func (s SchemaField) getDatasourceSchemaAttributeForList() datasourceSchema.Attribute {
+	var result datasourceSchema.Attribute
+	switch s.ValueType {
+	case StringEnum:
+		result = datasourceSchema.StringAttribute{
+			Computed:    true,
+			Sensitive:   s.Sensitive,
+			Description: s.Description,
+		}
+	case String:
+		result = datasourceSchema.StringAttribute{
+			Computed:    true,
+			Sensitive:   s.Sensitive,
+			Description: s.Description,
+		}
+	case Boolean:
+		result = datasourceSchema.BoolAttribute{
+			Computed:    true,
+			Description: s.Description,
+		}
+	case Integer:
+		result = datasourceSchema.Int64Attribute{
+			Computed:    true,
+			Description: s.Description,
+		}
+	case StringsList:
+		result = datasourceSchema.ListAttribute{
+			Computed:    true,
+			Sensitive:   s.Sensitive,
+			Description: s.Description,
+			ElementType: basetypes.StringType{},
+		}
+	case StringsSet:
+		result = datasourceSchema.SetAttribute{
+			Computed:    true,
+			Sensitive:   s.Sensitive,
+			Description: s.Description,
+			ElementType: basetypes.StringType{},
+		}
+	}
+
+	return result
+}
+
 func (s SchemaField) getResourceSchemaAttribute() resourceSchema.Attribute {
 	var result resourceSchema.Attribute
 	switch s.ValueType {

fivetran/framework/core/model/connectors.go

@@ -0,0 +1,78 @@
+package model
+
+import (
+    "context"
+    "fmt"
+
+    "github.com/fivetran/go-fivetran/connectors"
+    "github.com/hashicorp/terraform-plugin-framework/types"
+    "github.com/hashicorp/terraform-plugin-framework/attr"
+)
+
+type Connectors struct {
+    Id           types.String `tfsdk:"id"` 
+    Connectors   types.Set    `tfsdk:"connectors"`
+}
+
+func (d *Connectors) ReadFromResponse(ctx context.Context, resp connectors.ConnectorsListResponse) {
+    elementAttrType := map[string]attr.Type{
+        "id":                           types.StringType,
+        "name":                         types.StringType,
+        "connected_by":                 types.StringType,
+        "created_at":                   types.StringType,
+        "group_id":                     types.StringType,
+        "service":                      types.StringType,
+        "succeeded_at":                 types.StringType,
+        "failed_at":                    types.StringType,
+        "service_version":              types.StringType,
+        "sync_frequency":               types.Int64Type,
+        "schedule_type":                types.StringType,
+        "paused":                       types.BoolType,
+        "pause_after_trial":            types.BoolType,
+        "daily_sync_time":              types.StringType,
+        "data_delay_sensitivity":       types.StringType,
+        "data_delay_threshold":         types.Int64Type,
+        "proxy_agent_id":               types.StringType,
+        "networking_method":            types.StringType,
+        "local_processing_agent_id":    types.StringType,
+        "hybrid_deployment_agent_id":   types.StringType,
+        "private_link_id":              types.StringType,
+    }
+
+    if resp.Data.Items == nil {
+        d.Connectors = types.SetNull(types.ObjectType{AttrTypes: elementAttrType})
+    }
+
+    items := []attr.Value{}
+    
+    for _, v := range resp.Data.Items {
+        item := map[string]attr.Value{}
+        item["id"] = types.StringValue(v.ID)
+        item["name"] = types.StringValue(v.Schema)
+        item["connected_by"] = types.StringValue(v.ConnectedBy)
+        item["created_at"] = types.StringValue(v.CreatedAt.String())
+        item["group_id"] = types.StringValue(v.GroupID)
+        item["service"] = types.StringValue(v.Service)
+        item["succeeded_at"] = types.StringValue(v.SucceededAt.String())
+        item["failed_at"] = types.StringValue(v.FailedAt.String())
+        item["service_version"] = types.StringValue(fmt.Sprintf("%v", *v.ServiceVersion))
+        item["sync_frequency"] = types.Int64Value(int64(*v.SyncFrequency))
+        item["schedule_type"] = types.StringValue(v.ScheduleType)
+        item["paused"] = types.BoolValue(*v.Paused)
+        item["pause_after_trial"] = types.BoolValue(*v.PauseAfterTrial)
+        item["daily_sync_time"] = types.StringValue(v.DailySyncTime)
+        item["data_delay_sensitivity"] = types.StringValue(v.DataDelaySensitivity)
+        item["data_delay_threshold"] = types.Int64Value(int64(*v.DataDelayThreshold))
+        item["proxy_agent_id"] = types.StringValue(v.ProxyAgentId)
+        item["networking_method"] = types.StringValue(v.NetworkingMethod)
+        item["local_processing_agent_id"] = types.StringValue(v.HybridDeploymentAgentId)
+        item["hybrid_deployment_agent_id"] = types.StringValue(v.HybridDeploymentAgentId)
+        item["private_link_id"] = types.StringValue(v.PrivateLinkId)
+
+        objectValue, _ := types.ObjectValue(elementAttrType, item)
+        items = append(items, objectValue)
+    }
+
+    d.Id = types.StringValue("0")
+    d.Connectors, _ = types.SetValue(types.ObjectType{AttrTypes: elementAttrType}, items)
+}

fivetran/framework/core/model/destinations.go

@@ -0,0 +1,57 @@
+package model
+
+import (
+    "context"
+
+    "github.com/fivetran/go-fivetran/destinations"
+    "github.com/hashicorp/terraform-plugin-framework/types"
+    "github.com/hashicorp/terraform-plugin-framework/attr"
+)
+
+type Destinations struct {
+    Id              types.String `tfsdk:"id"` 
+    Destinations    types.Set    `tfsdk:"destinations"`
+}
+
+func (d *Destinations) ReadFromResponse(ctx context.Context, resp destinations.DestinationsListResponse) {
+    elementAttrType := map[string]attr.Type{
+        "id":                           types.StringType,
+        "group_id":                     types.StringType,
+        "service":                      types.StringType,
+        "region":                       types.StringType,
+        "time_zone_offset":             types.StringType,
+        "setup_status":                 types.StringType,
+        "networking_method":            types.StringType,
+        "local_processing_agent_id":    types.StringType,
+        "hybrid_deployment_agent_id":   types.StringType,
+        "private_link_id":              types.StringType,
+        "daylight_saving_time_enabled": types.BoolType,
+    }
+
+    if resp.Data.Items == nil {
+        d.Destinations = types.SetNull(types.ObjectType{AttrTypes: elementAttrType})
+    }
+
+    items := []attr.Value{}
+    
+    for _, v := range resp.Data.Items {
+        item := map[string]attr.Value{}
+        item["id"] = types.StringValue(v.ID)
+        item["group_id"] = types.StringValue(v.GroupID)
+        item["service"] = types.StringValue(v.Service)
+        item["region"] = types.StringValue(v.Region)
+        item["time_zone_offset"] = types.StringValue(v.TimeZoneOffset)
+        item["setup_status"] = types.StringValue(v.SetupStatus)
+        item["private_link_id"] = types.StringValue(v.PrivateLinkId)
+        item["local_processing_agent_id"] = types.StringValue(v.HybridDeploymentAgentId)
+        item["hybrid_deployment_agent_id"] = types.StringValue(v.HybridDeploymentAgentId)
+        item["networking_method"] = types.StringValue(v.NetworkingMethod)
+        item["daylight_saving_time_enabled"] = types.BoolValue(v.DaylightSavingTimeEnabled)
+
+        objectValue, _ := types.ObjectValue(elementAttrType, item)
+        items = append(items, objectValue)
+    }
+
+    d.Id = types.StringValue("0")
+    d.Destinations, _ = types.SetValue(types.ObjectType{AttrTypes: elementAttrType}, items)
+}

fivetran/framework/core/model/external_logs.go

@@ -0,0 +1,41 @@
+package model
+
+import (
+    "context"
+
+    "github.com/fivetran/go-fivetran/external_logging"
+    "github.com/hashicorp/terraform-plugin-framework/types"
+    "github.com/hashicorp/terraform-plugin-framework/attr"
+)
+
+type ExternalLogs struct {
+    Id              types.String `tfsdk:"id"` 
+    ExternalLogs    types.Set    `tfsdk:"logs"`
+}
+
+func (d *ExternalLogs) ReadFromResponse(ctx context.Context, resp externallogging.ExternalLoggingListResponse) {
+    elementAttrType := map[string]attr.Type{
+        "id":      types.StringType,
+        "service": types.StringType,
+        "enabled": types.BoolType,
+    }
+
+    if resp.Data.Items == nil {
+        d.ExternalLogs = types.SetNull(types.ObjectType{AttrTypes: elementAttrType})
+    }
+
+    items := []attr.Value{}
+    
+    for _, v := range resp.Data.Items {
+        item := map[string]attr.Value{}
+        item["id"] = types.StringValue(v.Id)
+        item["service"] = types.StringValue(v.Service)
+        item["enabled"] = types.BoolValue(v.Enabled)
+
+        objectValue, _ := types.ObjectValue(elementAttrType, item)
+        items = append(items, objectValue)
+    }
+
+    d.Id = types.StringValue("0")
+    d.ExternalLogs, _ = types.SetValue(types.ObjectType{AttrTypes: elementAttrType}, items)
+}