forked from airbytehq/terraform-provider-airbyte
/
source_googleanalyticsv4_data_source.go
executable file
·278 lines (257 loc) · 10.5 KB
/
source_googleanalyticsv4_data_source.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
// Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
package provider
import (
"github.com/ryan-pip/terraform-provider-airbyte/internal/sdk"
"github.com/ryan-pip/terraform-provider-airbyte/internal/sdk/pkg/models/operations"
"context"
"fmt"
"github.com/ryan-pip/terraform-provider-airbyte/internal/validators"
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)
// Ensure provider defined types fully satisfy framework interfaces.
var _ datasource.DataSource = &SourceGoogleAnalyticsV4DataSource{}
var _ datasource.DataSourceWithConfigure = &SourceGoogleAnalyticsV4DataSource{}
func NewSourceGoogleAnalyticsV4DataSource() datasource.DataSource {
return &SourceGoogleAnalyticsV4DataSource{}
}
// SourceGoogleAnalyticsV4DataSource is the data source implementation.
type SourceGoogleAnalyticsV4DataSource struct {
client *sdk.SDK
}
// SourceGoogleAnalyticsV4DataSourceModel describes the data model.
type SourceGoogleAnalyticsV4DataSourceModel struct {
Configuration SourceGoogleAnalyticsV4 `tfsdk:"configuration"`
Name types.String `tfsdk:"name"`
SecretID types.String `tfsdk:"secret_id"`
SourceID types.String `tfsdk:"source_id"`
WorkspaceID types.String `tfsdk:"workspace_id"`
}
// Metadata returns the data source type name.
func (r *SourceGoogleAnalyticsV4DataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_source_google_analytics_v4"
}
// Schema defines the schema for the data source.
func (r *SourceGoogleAnalyticsV4DataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: "SourceGoogleAnalyticsV4 DataSource",
Attributes: map[string]schema.Attribute{
"configuration": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"credentials": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"source_google_analytics_v4_credentials_authenticate_via_google_oauth": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"access_token": schema.StringAttribute{
Computed: true,
Description: `Access Token for making authenticated requests.`,
},
"auth_type": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"Client",
),
},
Description: `must be one of ["Client"]`,
},
"client_id": schema.StringAttribute{
Computed: true,
Description: `The Client ID of your Google Analytics developer application.`,
},
"client_secret": schema.StringAttribute{
Computed: true,
Description: `The Client Secret of your Google Analytics developer application.`,
},
"refresh_token": schema.StringAttribute{
Computed: true,
Description: `The token for obtaining a new access token.`,
},
},
Description: `Credentials for the service`,
},
"source_google_analytics_v4_credentials_service_account_key_authentication": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"auth_type": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"Service",
),
},
Description: `must be one of ["Service"]`,
},
"credentials_json": schema.StringAttribute{
Computed: true,
Description: `The JSON key of the service account to use for authorization`,
},
},
Description: `Credentials for the service`,
},
"source_google_analytics_v4_update_credentials_authenticate_via_google_oauth": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"access_token": schema.StringAttribute{
Computed: true,
Description: `Access Token for making authenticated requests.`,
},
"auth_type": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"Client",
),
},
Description: `must be one of ["Client"]`,
},
"client_id": schema.StringAttribute{
Computed: true,
Description: `The Client ID of your Google Analytics developer application.`,
},
"client_secret": schema.StringAttribute{
Computed: true,
Description: `The Client Secret of your Google Analytics developer application.`,
},
"refresh_token": schema.StringAttribute{
Computed: true,
Description: `The token for obtaining a new access token.`,
},
},
Description: `Credentials for the service`,
},
"source_google_analytics_v4_update_credentials_service_account_key_authentication": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"auth_type": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"Service",
),
},
Description: `must be one of ["Service"]`,
},
"credentials_json": schema.StringAttribute{
Computed: true,
Description: `The JSON key of the service account to use for authorization`,
},
},
Description: `Credentials for the service`,
},
},
Validators: []validator.Object{
validators.ExactlyOneChild(),
},
Description: `Credentials for the service`,
},
"custom_reports": schema.StringAttribute{
Computed: true,
Description: `A JSON array describing the custom reports you want to sync from Google Analytics. See <a href="https://docs.airbyte.com/integrations/sources/google-analytics-v4#data-processing-latency">the docs</a> for more information about the exact format you can use to fill out this field.`,
},
"source_type": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"google-analytics-v4",
),
},
Description: `must be one of ["google-analytics-v4"]`,
},
"start_date": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
validators.IsValidDate(),
},
Description: `The date in the format YYYY-MM-DD. Any data before this date will not be replicated.`,
},
"view_id": schema.StringAttribute{
Computed: true,
Description: `The ID for the Google Analytics View you want to fetch data from. This can be found from the <a href="https://ga-dev-tools.appspot.com/account-explorer/">Google Analytics Account Explorer</a>.`,
},
"window_in_days": schema.Int64Attribute{
Computed: true,
Description: `The time increment used by the connector when requesting data from the Google Analytics API. More information is available in the <a href="https://docs.airbyte.com/integrations/sources/google-analytics-v4/#sampling-in-reports">the docs</a>. The bigger this value is, the faster the sync will be, but the more likely that sampling will be applied to your data, potentially causing inaccuracies in the returned results. We recommend setting this to 1 unless you have a hard requirement to make the sync faster at the expense of accuracy. The minimum allowed value for this field is 1, and the maximum is 364. `,
},
},
},
"name": schema.StringAttribute{
Computed: true,
},
"secret_id": schema.StringAttribute{
Optional: true,
Description: `Optional secretID obtained through the public API OAuth redirect flow.`,
},
"source_id": schema.StringAttribute{
Required: true,
},
"workspace_id": schema.StringAttribute{
Computed: true,
},
},
}
}
func (r *SourceGoogleAnalyticsV4DataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
// Prevent panic if the provider has not been configured.
if req.ProviderData == nil {
return
}
client, ok := req.ProviderData.(*sdk.SDK)
if !ok {
resp.Diagnostics.AddError(
"Unexpected DataSource Configure Type",
fmt.Sprintf("Expected *sdk.SDK, got: %T. Please report this issue to the provider developers.", req.ProviderData),
)
return
}
r.client = client
}
func (r *SourceGoogleAnalyticsV4DataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
var data *SourceGoogleAnalyticsV4DataSourceModel
var item types.Object
resp.Diagnostics.Append(req.Config.Get(ctx, &item)...)
if resp.Diagnostics.HasError() {
return
}
resp.Diagnostics.Append(item.As(ctx, &data, basetypes.ObjectAsOptions{
UnhandledNullAsEmpty: true,
UnhandledUnknownAsEmpty: true,
})...)
if resp.Diagnostics.HasError() {
return
}
sourceID := data.SourceID.ValueString()
request := operations.GetSourceGoogleAnalyticsV4Request{
SourceID: sourceID,
}
res, err := r.client.Sources.GetSourceGoogleAnalyticsV4(ctx, request)
if err != nil {
resp.Diagnostics.AddError("failure to invoke API", err.Error())
if res != nil && res.RawResponse != nil {
resp.Diagnostics.AddError("unexpected http request/response", debugResponse(res.RawResponse))
}
return
}
if res == nil {
resp.Diagnostics.AddError("unexpected response from API", fmt.Sprintf("%v", res))
return
}
if res.StatusCode != 200 {
resp.Diagnostics.AddError(fmt.Sprintf("unexpected response from API. Got an unexpected response code %v", res.StatusCode), debugResponse(res.RawResponse))
return
}
if res.SourceResponse == nil {
resp.Diagnostics.AddError("unexpected response from API. No response body", debugResponse(res.RawResponse))
return
}
data.RefreshFromGetResponse(res.SourceResponse)
// Save updated data into Terraform state
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}