list_zone_transfer_servers_request_response.go

// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates.  All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.

package dns

import (
	"fmt"
	"github.com/oracle/oci-go-sdk/v65/common"
	"net/http"
	"strings"
)

// ListZoneTransferServersRequest wrapper for the ListZoneTransferServers operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dns/ListZoneTransferServers.go.html to see an example of how to use ListZoneTransferServersRequest.
type ListZoneTransferServersRequest struct {

	// The OCID of the compartment the resource belongs to.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Unique Oracle-assigned identifier for the request. If you need
	// to contact Oracle about a particular request, please provide
	// the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Specifies to operate only on resources that have a matching DNS scope.
	Scope ListZoneTransferServersScopeEnum `mandatory:"false" contributesTo:"query" name:"scope" omitEmpty:"true"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

func (request ListZoneTransferServersRequest) String() string {
	return common.PointerString(request)
}

// HTTPRequest implements the OCIRequest interface
func (request ListZoneTransferServersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error) {

	_, err := request.ValidateEnumValue()
	if err != nil {
		return http.Request{}, err
	}
	return common.MakeDefaultHTTPRequestWithTaggedStructAndExtraHeaders(method, path, request, extraHeaders)
}

// BinaryRequestBody implements the OCIRequest interface
func (request ListZoneTransferServersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListZoneTransferServersRequest) RetryPolicy() *common.RetryPolicy {
	return request.RequestMetadata.RetryPolicy
}

// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (request ListZoneTransferServersRequest) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingListZoneTransferServersScopeEnum(string(request.Scope)); !ok && request.Scope != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Scope: %s. Supported values are: %s.", request.Scope, strings.Join(GetListZoneTransferServersScopeEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ListZoneTransferServersResponse wrapper for the ListZoneTransferServers operation
type ListZoneTransferServersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []ZoneTransferServer instances
	Items []ZoneTransferServer `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to
	// contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages
	// of results remain. For important details about how pagination works,
	// see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (response ListZoneTransferServersResponse) String() string {
	return common.PointerString(response)
}

// HTTPResponse implements the OCIResponse interface
func (response ListZoneTransferServersResponse) HTTPResponse() *http.Response {
	return response.RawResponse
}

// ListZoneTransferServersScopeEnum Enum with underlying type: string
type ListZoneTransferServersScopeEnum string

// Set of constants representing the allowable values for ListZoneTransferServersScopeEnum
const (
	ListZoneTransferServersScopeGlobal  ListZoneTransferServersScopeEnum = "GLOBAL"
	ListZoneTransferServersScopePrivate ListZoneTransferServersScopeEnum = "PRIVATE"
)

var mappingListZoneTransferServersScopeEnum = map[string]ListZoneTransferServersScopeEnum{
	"GLOBAL":  ListZoneTransferServersScopeGlobal,
	"PRIVATE": ListZoneTransferServersScopePrivate,
}

var mappingListZoneTransferServersScopeEnumLowerCase = map[string]ListZoneTransferServersScopeEnum{
	"global":  ListZoneTransferServersScopeGlobal,
	"private": ListZoneTransferServersScopePrivate,
}

// GetListZoneTransferServersScopeEnumValues Enumerates the set of values for ListZoneTransferServersScopeEnum
func GetListZoneTransferServersScopeEnumValues() []ListZoneTransferServersScopeEnum {
	values := make([]ListZoneTransferServersScopeEnum, 0)
	for _, v := range mappingListZoneTransferServersScopeEnum {
		values = append(values, v)
	}
	return values
}

// GetListZoneTransferServersScopeEnumStringValues Enumerates the set of values in String for ListZoneTransferServersScopeEnum
func GetListZoneTransferServersScopeEnumStringValues() []string {
	return []string{
		"GLOBAL",
		"PRIVATE",
	}
}

// GetMappingListZoneTransferServersScopeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListZoneTransferServersScopeEnum(val string) (ListZoneTransferServersScopeEnum, bool) {
	enum, ok := mappingListZoneTransferServersScopeEnumLowerCase[strings.ToLower(val)]
	return enum, ok
}