alibaba-cloud-sdk-go/services/ecs/describe_images.go

package ecs

//Licensed under the Apache License, Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
//http://www.apache.org/licenses/LICENSE-2.0
//
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
//
// Code generated by Alibaba Cloud SDK Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.

import (
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/responses"
)

// DescribeImages invokes the ecs.DescribeImages API synchronously
// api document: https://help.aliyun.com/api/ecs/describeimages.html
func (client *Client) DescribeImages(request *DescribeImagesRequest) (response *DescribeImagesResponse, err error) {
	response = CreateDescribeImagesResponse()
	err = client.DoAction(request, response)
	return
}

// DescribeImagesWithChan invokes the ecs.DescribeImages API asynchronously
// api document: https://help.aliyun.com/api/ecs/describeimages.html
// asynchronous document: https://help.aliyun.com/document_detail/66220.html
func (client *Client) DescribeImagesWithChan(request *DescribeImagesRequest) (<-chan *DescribeImagesResponse, <-chan error) {
	responseChan := make(chan *DescribeImagesResponse, 1)
	errChan := make(chan error, 1)
	err := client.AddAsyncTask(func() {
		defer close(responseChan)
		defer close(errChan)
		response, err := client.DescribeImages(request)
		if err != nil {
			errChan <- err
		} else {
			responseChan <- response
		}
	})
	if err != nil {
		errChan <- err
		close(responseChan)
		close(errChan)
	}
	return responseChan, errChan
}

// DescribeImagesWithCallback invokes the ecs.DescribeImages API asynchronously
// api document: https://help.aliyun.com/api/ecs/describeimages.html
// asynchronous document: https://help.aliyun.com/document_detail/66220.html
func (client *Client) DescribeImagesWithCallback(request *DescribeImagesRequest, callback func(response *DescribeImagesResponse, err error)) <-chan int {
	result := make(chan int, 1)
	err := client.AddAsyncTask(func() {
		var response *DescribeImagesResponse
		var err error
		defer close(result)
		response, err = client.DescribeImages(request)
		callback(response, err)
		result <- 1
	})
	if err != nil {
		defer close(result)
		callback(nil, err)
		result <- 0
	}
	return result
}

// DescribeImagesRequest is the request struct for api DescribeImages
type DescribeImagesRequest struct {
	*requests.RpcRequest
	Tag4Value            string                  `position:"Query" name:"Tag.4.Value"`
	ActionType           string                  `position:"Query" name:"ActionType"`
	ResourceOwnerId      requests.Integer        `position:"Query" name:"ResourceOwnerId"`
	ImageId              string                  `position:"Query" name:"ImageId"`
	SnapshotId           string                  `position:"Query" name:"SnapshotId"`
	Tag2Key              string                  `position:"Query" name:"Tag.2.Key"`
	Usage                string                  `position:"Query" name:"Usage"`
	Tag3Key              string                  `position:"Query" name:"Tag.3.Key"`
	PageNumber           requests.Integer        `position:"Query" name:"PageNumber"`
	ImageOwnerAlias      string                  `position:"Query" name:"ImageOwnerAlias"`
	Tag1Value            string                  `position:"Query" name:"Tag.1.Value"`
	ResourceGroupId      string                  `position:"Query" name:"ResourceGroupId"`
	IsSupportIoOptimized requests.Boolean        `position:"Query" name:"IsSupportIoOptimized"`
	ImageName            string                  `position:"Query" name:"ImageName"`
	IsSupportCloudinit   requests.Boolean        `position:"Query" name:"IsSupportCloudinit"`
	PageSize             requests.Integer        `position:"Query" name:"PageSize"`
	InstanceType         string                  `position:"Query" name:"InstanceType"`
	Tag3Value            string                  `position:"Query" name:"Tag.3.Value"`
	Architecture         string                  `position:"Query" name:"Architecture"`
	DryRun               requests.Boolean        `position:"Query" name:"DryRun"`
	Tag5Key              string                  `position:"Query" name:"Tag.5.Key"`
	ResourceOwnerAccount string                  `position:"Query" name:"ResourceOwnerAccount"`
	OwnerAccount         string                  `position:"Query" name:"OwnerAccount"`
	ShowExpired          requests.Boolean        `position:"Query" name:"ShowExpired"`
	OSType               string                  `position:"Query" name:"OSType"`
	OwnerId              requests.Integer        `position:"Query" name:"OwnerId"`
	Tag5Value            string                  `position:"Query" name:"Tag.5.Value"`
	Tag1Key              string                  `position:"Query" name:"Tag.1.Key"`
	Filter               *[]DescribeImagesFilter `position:"Query" name:"Filter"  type:"Repeated"`
	Tag2Value            string                  `position:"Query" name:"Tag.2.Value"`
	Tag4Key              string                  `position:"Query" name:"Tag.4.Key"`
	Status               string                  `position:"Query" name:"Status"`
}

// DescribeImagesFilter is a repeated param struct in DescribeImagesRequest
type DescribeImagesFilter struct {
	Key   string `name:"Key"`
	Value string `name:"Value"`
}

// DescribeImagesResponse is the response struct for api DescribeImages
type DescribeImagesResponse struct {
	*responses.BaseResponse
	RequestId  string `json:"RequestId" xml:"RequestId"`
	RegionId   string `json:"RegionId" xml:"RegionId"`
	TotalCount int    `json:"TotalCount" xml:"TotalCount"`
	PageNumber int    `json:"PageNumber" xml:"PageNumber"`
	PageSize   int    `json:"PageSize" xml:"PageSize"`
	Images     Images `json:"Images" xml:"Images"`
}

// CreateDescribeImagesRequest creates a request to invoke DescribeImages API
func CreateDescribeImagesRequest() (request *DescribeImagesRequest) {
	request = &DescribeImagesRequest{
		RpcRequest: &requests.RpcRequest{},
	}
	request.InitWithApiInfo("Ecs", "2014-05-26", "DescribeImages", "ecs", "openAPI")
	return
}

// CreateDescribeImagesResponse creates a response to parse from DescribeImages response
func CreateDescribeImagesResponse() (response *DescribeImagesResponse) {
	response = &DescribeImagesResponse{
		BaseResponse: &responses.BaseResponse{},
	}
	return
}