/
getImages.go
193 lines (175 loc) · 5.68 KB
/
getImages.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
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package digitalocean
import (
"context"
"reflect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// Get information on images for use in other resources (e.g. creating a Droplet
// based on a snapshot), with the ability to filter and sort the results. If no filters are specified,
// all images will be returned.
//
// This data source is useful if the image in question is not managed by the provider or you need to utilize any
// of the image's data.
//
// Note: You can use the `getImage` data source to obtain metadata
// about a single image if you already know the `slug`, unique `name`, or `id` to retrieve.
//
// ## Example Usage
//
// Use the `filter` block with a `key` string and `values` list to filter images.
//
// For example to find all Ubuntu images:
//
// ```go
// package main
//
// import (
// "github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := digitalocean.GetImages(ctx, &GetImagesArgs{
// Filters: []GetImagesFilter{
// GetImagesFilter{
// Key: "distribution",
// Values: []string{
// "Ubuntu",
// },
// },
// },
// }, nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
// ```
//
// You can filter on multiple fields and sort the results as well:
//
// ```go
// package main
//
// import (
// "github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := digitalocean.GetImages(ctx, &GetImagesArgs{
// Filters: []GetImagesFilter{
// GetImagesFilter{
// Key: "distribution",
// Values: []string{
// "Ubuntu",
// },
// },
// GetImagesFilter{
// Key: "regions",
// Values: []string{
// "nyc3",
// },
// },
// },
// Sorts: []GetImagesSort{
// GetImagesSort{
// Direction: pulumi.StringRef("desc"),
// Key: "created",
// },
// },
// }, nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
// ```
func GetImages(ctx *pulumi.Context, args *GetImagesArgs, opts ...pulumi.InvokeOption) (*GetImagesResult, error) {
var rv GetImagesResult
err := ctx.Invoke("digitalocean:index/getImages:getImages", args, &rv, opts...)
if err != nil {
return nil, err
}
return &rv, nil
}
// A collection of arguments for invoking getImages.
type GetImagesArgs struct {
// Filter the results.
// The `filter` block is documented below.
Filters []GetImagesFilter `pulumi:"filters"`
// Sort the results.
// The `sort` block is documented below.
Sorts []GetImagesSort `pulumi:"sorts"`
}
// A collection of values returned by getImages.
type GetImagesResult struct {
Filters []GetImagesFilter `pulumi:"filters"`
// The provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
// A set of images satisfying any `filter` and `sort` criteria. Each image has the following attributes:
// - `slug`: Unique text identifier of the image.
// - `id`: The ID of the image.
// - `name`: The name of the image.
// - `type`: Type of the image.
Images []GetImagesImage `pulumi:"images"`
Sorts []GetImagesSort `pulumi:"sorts"`
}
func GetImagesOutput(ctx *pulumi.Context, args GetImagesOutputArgs, opts ...pulumi.InvokeOption) GetImagesResultOutput {
return pulumi.ToOutputWithContext(context.Background(), args).
ApplyT(func(v interface{}) (GetImagesResult, error) {
args := v.(GetImagesArgs)
r, err := GetImages(ctx, &args, opts...)
return *r, err
}).(GetImagesResultOutput)
}
// A collection of arguments for invoking getImages.
type GetImagesOutputArgs struct {
// Filter the results.
// The `filter` block is documented below.
Filters GetImagesFilterArrayInput `pulumi:"filters"`
// Sort the results.
// The `sort` block is documented below.
Sorts GetImagesSortArrayInput `pulumi:"sorts"`
}
func (GetImagesOutputArgs) ElementType() reflect.Type {
return reflect.TypeOf((*GetImagesArgs)(nil)).Elem()
}
// A collection of values returned by getImages.
type GetImagesResultOutput struct{ *pulumi.OutputState }
func (GetImagesResultOutput) ElementType() reflect.Type {
return reflect.TypeOf((*GetImagesResult)(nil)).Elem()
}
func (o GetImagesResultOutput) ToGetImagesResultOutput() GetImagesResultOutput {
return o
}
func (o GetImagesResultOutput) ToGetImagesResultOutputWithContext(ctx context.Context) GetImagesResultOutput {
return o
}
func (o GetImagesResultOutput) Filters() GetImagesFilterArrayOutput {
return o.ApplyT(func(v GetImagesResult) []GetImagesFilter { return v.Filters }).(GetImagesFilterArrayOutput)
}
// The provider-assigned unique ID for this managed resource.
func (o GetImagesResultOutput) Id() pulumi.StringOutput {
return o.ApplyT(func(v GetImagesResult) string { return v.Id }).(pulumi.StringOutput)
}
// A set of images satisfying any `filter` and `sort` criteria. Each image has the following attributes:
// - `slug`: Unique text identifier of the image.
// - `id`: The ID of the image.
// - `name`: The name of the image.
// - `type`: Type of the image.
func (o GetImagesResultOutput) Images() GetImagesImageArrayOutput {
return o.ApplyT(func(v GetImagesResult) []GetImagesImage { return v.Images }).(GetImagesImageArrayOutput)
}
func (o GetImagesResultOutput) Sorts() GetImagesSortArrayOutput {
return o.ApplyT(func(v GetImagesResult) []GetImagesSort { return v.Sorts }).(GetImagesSortArrayOutput)
}
func init() {
pulumi.RegisterOutputType(GetImagesResultOutput{})
}