DescribeUserView.go raw
1 // Copyright 2018 JDCLOUD.COM
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 //
15 // NOTE: This class is auto generated by the jdcloud code generator program.
16
17 package apis
18
19 import (
20 "github.com/go-acme/jdcloud-sdk-go/core"
21 domainservice "github.com/go-acme/jdcloud-sdk-go/services/domainservice/models"
22 )
23
24 type DescribeUserViewRequest struct {
25 core.JDCloudRequest
26
27 /* 地域ID */
28 RegionId string `json:"regionId"`
29
30 /* 域名ID，请使用describeDomains接口获取。 */
31 DomainId string `json:"domainId"`
32
33 /* 自定义线路ID */
34 ViewId int `json:"viewId"`
35
36 /* 自定义线路名称, 最多64个字节，允许：数字、字母、下划线，-，中文 (Optional) */
37 ViewName *string `json:"viewName"`
38
39 /* 分页参数，页的序号 */
40 PageNumber int `json:"pageNumber"`
41
42 /* 分页参数，每页含有的结果的数目 */
43 PageSize int `json:"pageSize"`
44 }
45
46 /*
47 * param regionId: 地域ID (Required)
48 * param domainId: 域名ID，请使用describeDomains接口获取。 (Required)
49 * param viewId: 自定义线路ID (Required)
50 * param pageNumber: 分页参数，页的序号 (Required)
51 * param pageSize: 分页参数，每页含有的结果的数目 (Required)
52 *
53 * @Deprecated, not compatible when mandatory parameters changed
54 */
55 func NewDescribeUserViewRequest(
56 regionId string,
57 domainId string,
58 viewId int,
59 pageNumber int,
60 pageSize int,
61 ) *DescribeUserViewRequest {
62
63 return &DescribeUserViewRequest{
64 JDCloudRequest: core.JDCloudRequest{
65 URL: "/regions/{regionId}/domain/{domainId}/UserView",
66 Method: "GET",
67 Header: nil,
68 Version: "v2",
69 },
70 RegionId: regionId,
71 DomainId: domainId,
72 ViewId: viewId,
73 PageNumber: pageNumber,
74 PageSize: pageSize,
75 }
76 }
77
78 /*
79 * param regionId: 地域ID (Required)
80 * param domainId: 域名ID，请使用describeDomains接口获取。 (Required)
81 * param viewId: 自定义线路ID (Required)
82 * param viewName: 自定义线路名称, 最多64个字节，允许：数字、字母、下划线，-，中文 (Optional)
83 * param pageNumber: 分页参数，页的序号 (Required)
84 * param pageSize: 分页参数，每页含有的结果的数目 (Required)
85 */
86 func NewDescribeUserViewRequestWithAllParams(
87 regionId string,
88 domainId string,
89 viewId int,
90 viewName *string,
91 pageNumber int,
92 pageSize int,
93 ) *DescribeUserViewRequest {
94
95 return &DescribeUserViewRequest{
96 JDCloudRequest: core.JDCloudRequest{
97 URL: "/regions/{regionId}/domain/{domainId}/UserView",
98 Method: "GET",
99 Header: nil,
100 Version: "v2",
101 },
102 RegionId: regionId,
103 DomainId: domainId,
104 ViewId: viewId,
105 ViewName: viewName,
106 PageNumber: pageNumber,
107 PageSize: pageSize,
108 }
109 }
110
111 /* This constructor has better compatible ability when API parameters changed */
112 func NewDescribeUserViewRequestWithoutParam() *DescribeUserViewRequest {
113
114 return &DescribeUserViewRequest{
115 JDCloudRequest: core.JDCloudRequest{
116 URL: "/regions/{regionId}/domain/{domainId}/UserView",
117 Method: "GET",
118 Header: nil,
119 Version: "v2",
120 },
121 }
122 }
123
124 /* param regionId: 地域ID(Required) */
125 func (r *DescribeUserViewRequest) SetRegionId(regionId string) {
126 r.RegionId = regionId
127 }
128
129 /* param domainId: 域名ID，请使用describeDomains接口获取。(Required) */
130 func (r *DescribeUserViewRequest) SetDomainId(domainId string) {
131 r.DomainId = domainId
132 }
133
134 /* param viewId: 自定义线路ID(Required) */
135 func (r *DescribeUserViewRequest) SetViewId(viewId int) {
136 r.ViewId = viewId
137 }
138
139 /* param viewName: 自定义线路名称, 最多64个字节，允许：数字、字母、下划线，-，中文(Optional) */
140 func (r *DescribeUserViewRequest) SetViewName(viewName string) {
141 r.ViewName = &viewName
142 }
143
144 /* param pageNumber: 分页参数，页的序号(Required) */
145 func (r *DescribeUserViewRequest) SetPageNumber(pageNumber int) {
146 r.PageNumber = pageNumber
147 }
148
149 /* param pageSize: 分页参数，每页含有的结果的数目(Required) */
150 func (r *DescribeUserViewRequest) SetPageSize(pageSize int) {
151 r.PageSize = pageSize
152 }
153
154 // GetRegionId returns path parameter 'regionId' if exist,
155 // otherwise return empty string
156 func (r DescribeUserViewRequest) GetRegionId() string {
157 return r.RegionId
158 }
159
160 type DescribeUserViewResponse struct {
161 RequestID string `json:"requestId"`
162 Error core.ErrorResponse `json:"error"`
163 Result DescribeUserViewResult `json:"result"`
164 }
165
166 type DescribeUserViewResult struct {
167 DataList []domainservice.UserViewInput `json:"dataList"`
168 CurrentCount int `json:"currentCount"`
169 TotalCount int `json:"totalCount"`
170 TotalPage int `json:"totalPage"`
171 }
172