authenticate_client_request_response.go

// Copyright © 2019, Oracle and/or its affiliates.
package ociauth

import (
	"net/http"

	"github.com/oracle/oci-go-sdk/v65/common"
)

// Do not edit this file. This is based on standard OCI GO SDK format

// Stores the request body and meta-data required for authenticating the client
type AuthenticateClientRequest struct {
	// Request object for AuthenticateClientRequest
	AuthenticateClientDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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"`

	// 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
}

// Prints the values of pointers in AuthenticateClientRequest,
// producing a human friendly string for an struct with pointers. Useful when debugging the values of a struct.
func (request AuthenticateClientRequest) String() string {
	return common.PointerString(request)
}

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

// BinaryRequestBody implements the OCIRequest interface
func (request AuthenticateClientRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
	return nil, false
}

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

// Stores the response of the AuthenticateClient request, including meta-data.
type AuthenticateClientResponse struct {
	// The underlying http response
	RawResponse *http.Response

	// The AuthenticateClientResult instance
	AuthenticateClientResult `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 optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

// Prints the values of pointers in AuthenticateClientResponse,
// producing a human friendly string for an struct with pointers. Useful when debugging the values of a struct.
func (response AuthenticateClientResponse) String() string {
	return common.PointerString(response)
}

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