|
| 1 | +// NOTE: This file was generated by the ServiceGenerator. |
| 2 | + |
| 3 | +// ---------------------------------------------------------------------------- |
| 4 | +// API: |
| 5 | +// Access Approval API (accessapproval/v1beta1) |
| 6 | +// Description: |
| 7 | +// An API for controlling access to data by Google personnel. |
| 8 | +// Documentation: |
| 9 | +// https://cloud.google.com/access-approval/docs |
| 10 | + |
| 11 | +#if GTLR_BUILT_AS_FRAMEWORK |
| 12 | + #import "GTLR/GTLRObject.h" |
| 13 | +#else |
| 14 | + #import "GTLRObject.h" |
| 15 | +#endif |
| 16 | + |
| 17 | +#if GTLR_RUNTIME_VERSION != 3000 |
| 18 | +#error This file was generated by a different version of ServiceGenerator which is incompatible with this GTLR library source. |
| 19 | +#endif |
| 20 | + |
| 21 | +@class GTLRAccessApproval_AccessLocations; |
| 22 | +@class GTLRAccessApproval_AccessReason; |
| 23 | +@class GTLRAccessApproval_ApprovalRequest; |
| 24 | +@class GTLRAccessApproval_ApproveDecision; |
| 25 | +@class GTLRAccessApproval_DismissDecision; |
| 26 | + |
| 27 | +// Generated comments include content from the discovery document; avoid them |
| 28 | +// causing warnings since clang's checks are some what arbitrary. |
| 29 | +#pragma clang diagnostic push |
| 30 | +#pragma clang diagnostic ignored "-Wdocumentation" |
| 31 | + |
| 32 | +NS_ASSUME_NONNULL_BEGIN |
| 33 | + |
| 34 | +// ---------------------------------------------------------------------------- |
| 35 | +// Constants - For some of the classes' properties below. |
| 36 | + |
| 37 | +// ---------------------------------------------------------------------------- |
| 38 | +// GTLRAccessApproval_AccessReason.type |
| 39 | + |
| 40 | +/** |
| 41 | + * Customer made a request or raised an issue that required the principal to |
| 42 | + * access customer data. `detail` is of the form ("#####" is the issue ID): |
| 43 | + * <ol> |
| 44 | + * <li>"Feedback Report: #####"</li> |
| 45 | + * <li>"Case Number: #####"</li> |
| 46 | + * <li>"Case ID: #####"</li> |
| 47 | + * <li>"E-PIN Reference: #####"</li> |
| 48 | + * <li>"Google-#####"</li> |
| 49 | + * <li>"T-#####"</li> |
| 50 | + * </ol> |
| 51 | + * |
| 52 | + * Value: "CUSTOMER_INITIATED_SUPPORT" |
| 53 | + */ |
| 54 | +GTLR_EXTERN NSString * const kGTLRAccessApproval_AccessReason_Type_CustomerInitiatedSupport; |
| 55 | +/** |
| 56 | + * Google initiated service for security, fraud, abuse, or compliance |
| 57 | + * purposes. |
| 58 | + * |
| 59 | + * Value: "GOOGLE_INITIATED_REVIEW" |
| 60 | + */ |
| 61 | +GTLR_EXTERN NSString * const kGTLRAccessApproval_AccessReason_Type_GoogleInitiatedReview; |
| 62 | +/** |
| 63 | + * The principal accessed customer data in order to diagnose or resolve a |
| 64 | + * suspected issue in services or a known outage. Often this access is used |
| 65 | + * to confirm that customers are not affected by a suspected service issue |
| 66 | + * or to remediate a reversible system issue. |
| 67 | + * |
| 68 | + * Value: "GOOGLE_INITIATED_SERVICE" |
| 69 | + */ |
| 70 | +GTLR_EXTERN NSString * const kGTLRAccessApproval_AccessReason_Type_GoogleInitiatedService; |
| 71 | +/** |
| 72 | + * Default value for proto, shouldn't be used. |
| 73 | + * |
| 74 | + * Value: "TYPE_UNSPECIFIED" |
| 75 | + */ |
| 76 | +GTLR_EXTERN NSString * const kGTLRAccessApproval_AccessReason_Type_TypeUnspecified; |
| 77 | + |
| 78 | +/** |
| 79 | + * Home office and physical location of the principal. |
| 80 | + */ |
| 81 | +@interface GTLRAccessApproval_AccessLocations : GTLRObject |
| 82 | + |
| 83 | +/** |
| 84 | + * The "home office" location of the principal. A two-letter country code |
| 85 | + * (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some |
| 86 | + * limited situations Google systems may refer refer to a region code instead |
| 87 | + * of a country code. |
| 88 | + * Possible Region Codes: |
| 89 | + * <ol> |
| 90 | + * <li>ASI: Asia</li> |
| 91 | + * <li>EUR: Europe</li> |
| 92 | + * <li>OCE: Oceania</li> |
| 93 | + * <li>AFR: Africa</li> |
| 94 | + * <li>NAM: North America</li> |
| 95 | + * <li>SAM: South America</li> |
| 96 | + * <li>ANT: Antarctica</li> |
| 97 | + * <li>ANY: Any location</li> |
| 98 | + * </ol> |
| 99 | + */ |
| 100 | +@property(nonatomic, copy, nullable) NSString *principalOfficeCountry; |
| 101 | + |
| 102 | +/** |
| 103 | + * Physical location of the principal at the time of the access. A |
| 104 | + * two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or |
| 105 | + * a region code. In some limited situations Google systems may refer refer to |
| 106 | + * a region code instead of a country code. |
| 107 | + * Possible Region Codes: |
| 108 | + * <ol> |
| 109 | + * <li>ASI: Asia</li> |
| 110 | + * <li>EUR: Europe</li> |
| 111 | + * <li>OCE: Oceania</li> |
| 112 | + * <li>AFR: Africa</li> |
| 113 | + * <li>NAM: North America</li> |
| 114 | + * <li>SAM: South America</li> |
| 115 | + * <li>ANT: Antarctica</li> |
| 116 | + * <li>ANY: Any location</li> |
| 117 | + * </ol> |
| 118 | + */ |
| 119 | +@property(nonatomic, copy, nullable) NSString *principalPhysicalLocationCountry; |
| 120 | + |
| 121 | +@end |
| 122 | + |
| 123 | + |
| 124 | +/** |
| 125 | + * GTLRAccessApproval_AccessReason |
| 126 | + */ |
| 127 | +@interface GTLRAccessApproval_AccessReason : GTLRObject |
| 128 | + |
| 129 | +/** |
| 130 | + * More detail about certain reason types. See comments for each type above. |
| 131 | + */ |
| 132 | +@property(nonatomic, copy, nullable) NSString *detail; |
| 133 | + |
| 134 | +/** |
| 135 | + * Type of access justification. |
| 136 | + * |
| 137 | + * Likely values: |
| 138 | + * @arg @c kGTLRAccessApproval_AccessReason_Type_CustomerInitiatedSupport |
| 139 | + * Customer made a request or raised an issue that required the principal |
| 140 | + * to |
| 141 | + * access customer data. `detail` is of the form ("#####" is the issue |
| 142 | + * ID): |
| 143 | + * <ol> |
| 144 | + * <li>"Feedback Report: #####"</li> |
| 145 | + * <li>"Case Number: #####"</li> |
| 146 | + * <li>"Case ID: #####"</li> |
| 147 | + * <li>"E-PIN Reference: #####"</li> |
| 148 | + * <li>"Google-#####"</li> |
| 149 | + * <li>"T-#####"</li> |
| 150 | + * </ol> (Value: "CUSTOMER_INITIATED_SUPPORT") |
| 151 | + * @arg @c kGTLRAccessApproval_AccessReason_Type_GoogleInitiatedReview Google |
| 152 | + * initiated service for security, fraud, abuse, or compliance |
| 153 | + * purposes. (Value: "GOOGLE_INITIATED_REVIEW") |
| 154 | + * @arg @c kGTLRAccessApproval_AccessReason_Type_GoogleInitiatedService The |
| 155 | + * principal accessed customer data in order to diagnose or resolve a |
| 156 | + * suspected issue in services or a known outage. Often this access is |
| 157 | + * used |
| 158 | + * to confirm that customers are not affected by a suspected service |
| 159 | + * issue |
| 160 | + * or to remediate a reversible system issue. (Value: |
| 161 | + * "GOOGLE_INITIATED_SERVICE") |
| 162 | + * @arg @c kGTLRAccessApproval_AccessReason_Type_TypeUnspecified Default |
| 163 | + * value for proto, shouldn't be used. (Value: "TYPE_UNSPECIFIED") |
| 164 | + */ |
| 165 | +@property(nonatomic, copy, nullable) NSString *type; |
| 166 | + |
| 167 | +@end |
| 168 | + |
| 169 | + |
| 170 | +/** |
| 171 | + * A request for the customer to approve access to a resource. |
| 172 | + */ |
| 173 | +@interface GTLRAccessApproval_ApprovalRequest : GTLRObject |
| 174 | + |
| 175 | +/** Access was approved. */ |
| 176 | +@property(nonatomic, strong, nullable) GTLRAccessApproval_ApproveDecision *approve; |
| 177 | + |
| 178 | +/** The request was dismissed. */ |
| 179 | +@property(nonatomic, strong, nullable) GTLRAccessApproval_DismissDecision *dismiss; |
| 180 | + |
| 181 | +/** |
| 182 | + * The resource name of the request. Format is |
| 183 | + * "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}". |
| 184 | + */ |
| 185 | +@property(nonatomic, copy, nullable) NSString *name; |
| 186 | + |
| 187 | +/** |
| 188 | + * The requested expiration for the approval. If the request is approved, |
| 189 | + * access will be granted from the time of approval until the expiration time. |
| 190 | + */ |
| 191 | +@property(nonatomic, strong, nullable) GTLRDateTime *requestedExpiration; |
| 192 | + |
| 193 | +/** The locations for which approval is being requested. */ |
| 194 | +@property(nonatomic, strong, nullable) GTLRAccessApproval_AccessLocations *requestedLocations; |
| 195 | + |
| 196 | +/** The justification for which approval is being requested. */ |
| 197 | +@property(nonatomic, strong, nullable) GTLRAccessApproval_AccessReason *requestedReason; |
| 198 | + |
| 199 | +/** |
| 200 | + * The resource for which approval is being requested. The format of the |
| 201 | + * resource name is defined at |
| 202 | + * https://cloud.google.com/apis/design/resource_names. The resource name here |
| 203 | + * may either be a "full" resource name (e.g. |
| 204 | + * "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" |
| 205 | + * resource name (e.g. "shelves/shelf1/books/book2") as described in the |
| 206 | + * resource name specification. |
| 207 | + */ |
| 208 | +@property(nonatomic, copy, nullable) NSString *requestedResourceName; |
| 209 | + |
| 210 | +/** The time at which approval was requested. */ |
| 211 | +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; |
| 212 | + |
| 213 | +@end |
| 214 | + |
| 215 | + |
| 216 | +/** |
| 217 | + * Request to approve an ApprovalRequest. |
| 218 | + */ |
| 219 | +@interface GTLRAccessApproval_ApproveApprovalRequestMessage : GTLRObject |
| 220 | + |
| 221 | +/** The expiration time of this approval. */ |
| 222 | +@property(nonatomic, strong, nullable) GTLRDateTime *expireTime; |
| 223 | + |
| 224 | +@end |
| 225 | + |
| 226 | + |
| 227 | +/** |
| 228 | + * A decision that has been made to approve access to a resource. |
| 229 | + */ |
| 230 | +@interface GTLRAccessApproval_ApproveDecision : GTLRObject |
| 231 | + |
| 232 | +/** The time at which approval was granted. */ |
| 233 | +@property(nonatomic, strong, nullable) GTLRDateTime *approveTime; |
| 234 | + |
| 235 | +/** The time at which the approval expires. */ |
| 236 | +@property(nonatomic, strong, nullable) GTLRDateTime *expireTime; |
| 237 | + |
| 238 | +@end |
| 239 | + |
| 240 | + |
| 241 | +/** |
| 242 | + * Request to dismiss an approval request. |
| 243 | + */ |
| 244 | +@interface GTLRAccessApproval_DismissApprovalRequestMessage : GTLRObject |
| 245 | +@end |
| 246 | + |
| 247 | + |
| 248 | +/** |
| 249 | + * A decision that has been made to dismiss an approval request. |
| 250 | + */ |
| 251 | +@interface GTLRAccessApproval_DismissDecision : GTLRObject |
| 252 | + |
| 253 | +/** The time at which the approval request was dismissed. */ |
| 254 | +@property(nonatomic, strong, nullable) GTLRDateTime *dismissTime; |
| 255 | + |
| 256 | +@end |
| 257 | + |
| 258 | + |
| 259 | +/** |
| 260 | + * Response to listing of ApprovalRequest objects. |
| 261 | + * |
| 262 | + * @note This class supports NSFastEnumeration and indexed subscripting over |
| 263 | + * its "approvalRequests" property. If returned as the result of a query, |
| 264 | + * it should support automatic pagination (when @c shouldFetchNextPages |
| 265 | + * is enabled). |
| 266 | + */ |
| 267 | +@interface GTLRAccessApproval_ListApprovalRequestsResponse : GTLRCollectionObject |
| 268 | + |
| 269 | +/** |
| 270 | + * Approval request details. |
| 271 | + * |
| 272 | + * @note This property is used to support NSFastEnumeration and indexed |
| 273 | + * subscripting on this class. |
| 274 | + */ |
| 275 | +@property(nonatomic, strong, nullable) NSArray<GTLRAccessApproval_ApprovalRequest *> *approvalRequests; |
| 276 | + |
| 277 | +/** |
| 278 | + * Token to retrieve the next page of results, or empty if there are no more. |
| 279 | + */ |
| 280 | +@property(nonatomic, copy, nullable) NSString *nextPageToken; |
| 281 | + |
| 282 | +@end |
| 283 | + |
| 284 | + |
| 285 | +/** |
| 286 | + * Settings on a Project/Folder/Organization related to Access Approval. |
| 287 | + */ |
| 288 | +@interface GTLRAccessApproval_Settings : GTLRObject |
| 289 | + |
| 290 | +/** |
| 291 | + * The resource name of the settings. Format is one of: |
| 292 | + * <ol> |
| 293 | + * <li>"projects/{project_id}/accessApprovalSettings"</li> |
| 294 | + * <li>"folders/{folder_id}/accessApprovalSettings"</li> |
| 295 | + * <li>"organizations/{organization_id}/accessApprovalSettings"</li> |
| 296 | + * <ol> |
| 297 | + */ |
| 298 | +@property(nonatomic, copy, nullable) NSString *name; |
| 299 | + |
| 300 | +/** |
| 301 | + * A list of email addresses to which notifications relating to approval |
| 302 | + * requests should be sent. Notifications relating to a resource will be sent |
| 303 | + * to all emails in the settings of ancestor resources of that resource. |
| 304 | + */ |
| 305 | +@property(nonatomic, strong, nullable) NSArray<NSString *> *notificationEmails; |
| 306 | + |
| 307 | +@end |
| 308 | + |
| 309 | +NS_ASSUME_NONNULL_END |
| 310 | + |
| 311 | +#pragma clang diagnostic pop |
0 commit comments