1// Copyright (c) 2016, 2018, 2019, Oracle and/or its affiliates. All rights reserved.
2// Code generated. DO NOT EDIT.
3
4package core
5
6import (
7	"github.com/oracle/oci-go-sdk/common"
8	"net/http"
9)
10
11// ListVolumeAttachmentsRequest wrapper for the ListVolumeAttachments operation
12type ListVolumeAttachmentsRequest struct {
13
14	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
15	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
16
17	// The name of the availability domain.
18	// Example: `Uocm:PHX-AD-1`
19	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
20
21	// For list pagination. The maximum number of results per page, or items to return in a paginated
22	// "List" call. For important details about how pagination works, see
23	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
24	// Example: `50`
25	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
26
27	// For list pagination. The value of the `opc-next-page` response header from the previous "List"
28	// call. For important details about how pagination works, see
29	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
30	Page *string `mandatory:"false" contributesTo:"query" name:"page"`
31
32	// The OCID of the instance.
33	InstanceId *string `mandatory:"false" contributesTo:"query" name:"instanceId"`
34
35	// The OCID of the volume.
36	VolumeId *string `mandatory:"false" contributesTo:"query" name:"volumeId"`
37
38	// Unique Oracle-assigned identifier for the request.
39	// If you need to contact Oracle about a particular request, please provide the request ID.
40	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
41
42	// Metadata about the request. This information will not be transmitted to the service, but
43	// represents information that the SDK will consume to drive retry behavior.
44	RequestMetadata common.RequestMetadata
45}
46
47func (request ListVolumeAttachmentsRequest) String() string {
48	return common.PointerString(request)
49}
50
51// HTTPRequest implements the OCIRequest interface
52func (request ListVolumeAttachmentsRequest) HTTPRequest(method, path string) (http.Request, error) {
53	return common.MakeDefaultHTTPRequestWithTaggedStruct(method, path, request)
54}
55
56// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
57func (request ListVolumeAttachmentsRequest) RetryPolicy() *common.RetryPolicy {
58	return request.RequestMetadata.RetryPolicy
59}
60
61// ListVolumeAttachmentsResponse wrapper for the ListVolumeAttachments operation
62type ListVolumeAttachmentsResponse struct {
63
64	// The underlying http response
65	RawResponse *http.Response
66
67	// A list of []VolumeAttachment instances
68	Items []VolumeAttachment `presentIn:"body"`
69
70	// For list pagination. When this header appears in the response, additional pages
71	// of results remain. For important details about how pagination works, see
72	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
73	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
74
75	// Unique Oracle-assigned identifier for the request. If you need to contact
76	// Oracle about a particular request, please provide the request ID.
77	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
78}
79
80func (response ListVolumeAttachmentsResponse) String() string {
81	return common.PointerString(response)
82}
83
84// HTTPResponse implements the OCIResponse interface
85func (response ListVolumeAttachmentsResponse) HTTPResponse() *http.Response {
86	return response.RawResponse
87}
88