func GetApiLifecycleStateEnumStringValues() []string
GetApiLifecycleStateEnumStringValues Enumerates the set of values in String for ApiLifecycleStateEnum
func GetApiSpecificationRouteBackendTypeEnumStringValues() []string
GetApiSpecificationRouteBackendTypeEnumStringValues Enumerates the set of values in String for ApiSpecificationRouteBackendTypeEnum
func GetApiSpecificationRouteMethodsEnumStringValues() []string
GetApiSpecificationRouteMethodsEnumStringValues Enumerates the set of values in String for ApiSpecificationRouteMethodsEnum
func GetApiSummaryLifecycleStateEnumStringValues() []string
GetApiSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ApiSummaryLifecycleStateEnum
func GetApiValidationDetailSeverityEnumStringValues() []string
GetApiValidationDetailSeverityEnumStringValues Enumerates the set of values in String for ApiValidationDetailSeverityEnum
func GetApiValidationDetailsResultEnumStringValues() []string
GetApiValidationDetailsResultEnumStringValues Enumerates the set of values in String for ApiValidationDetailsResultEnum
func GetApiValidationResultResultEnumStringValues() []string
GetApiValidationResultResultEnumStringValues Enumerates the set of values in String for ApiValidationResultResultEnum
func GetAuthenticationPolicyTypeEnumStringValues() []string
GetAuthenticationPolicyTypeEnumStringValues Enumerates the set of values in String for AuthenticationPolicyTypeEnum
func GetBodyValidationRequestPolicyValidationModeEnumStringValues() []string
GetBodyValidationRequestPolicyValidationModeEnumStringValues Enumerates the set of values in String for BodyValidationRequestPolicyValidationModeEnum
func GetCaBundleTypeEnumStringValues() []string
GetCaBundleTypeEnumStringValues Enumerates the set of values in String for CaBundleTypeEnum
func GetCertificateLifecycleStateEnumStringValues() []string
GetCertificateLifecycleStateEnumStringValues Enumerates the set of values in String for CertificateLifecycleStateEnum
func GetClientAppDetailsTypeEnumStringValues() []string
GetClientAppDetailsTypeEnumStringValues Enumerates the set of values in String for ClientAppDetailsTypeEnum
func GetContentValidationValidationTypeEnumStringValues() []string
GetContentValidationValidationTypeEnumStringValues Enumerates the set of values in String for ContentValidationValidationTypeEnum
func GetDeploymentLifecycleStateEnumStringValues() []string
GetDeploymentLifecycleStateEnumStringValues Enumerates the set of values in String for DeploymentLifecycleStateEnum
func GetDynamicSelectionKeyTypeEnumStringValues() []string
GetDynamicSelectionKeyTypeEnumStringValues Enumerates the set of values in String for DynamicSelectionKeyTypeEnum
func GetExecutionLogPolicyLogLevelEnumStringValues() []string
GetExecutionLogPolicyLogLevelEnumStringValues Enumerates the set of values in String for ExecutionLogPolicyLogLevelEnum
func GetFilterHeaderPolicyTypeEnumStringValues() []string
GetFilterHeaderPolicyTypeEnumStringValues Enumerates the set of values in String for FilterHeaderPolicyTypeEnum
func GetFilterQueryParameterPolicyTypeEnumStringValues() []string
GetFilterQueryParameterPolicyTypeEnumStringValues Enumerates the set of values in String for FilterQueryParameterPolicyTypeEnum
func GetGatewayEndpointTypeEnumStringValues() []string
GetGatewayEndpointTypeEnumStringValues Enumerates the set of values in String for GatewayEndpointTypeEnum
func GetGatewayLifecycleStateEnumStringValues() []string
GetGatewayLifecycleStateEnumStringValues Enumerates the set of values in String for GatewayLifecycleStateEnum
func GetHeaderValidationRequestPolicyValidationModeEnumStringValues() []string
GetHeaderValidationRequestPolicyValidationModeEnumStringValues Enumerates the set of values in String for HeaderValidationRequestPolicyValidationModeEnum
func GetJsonWebKeyKeyOpsEnumStringValues() []string
GetJsonWebKeyKeyOpsEnumStringValues Enumerates the set of values in String for JsonWebKeyKeyOpsEnum
func GetJsonWebKeyKtyEnumStringValues() []string
GetJsonWebKeyKtyEnumStringValues Enumerates the set of values in String for JsonWebKeyKtyEnum
func GetJsonWebKeyUseEnumStringValues() []string
GetJsonWebKeyUseEnumStringValues Enumerates the set of values in String for JsonWebKeyUseEnum
func GetListApisSortByEnumStringValues() []string
GetListApisSortByEnumStringValues Enumerates the set of values in String for ListApisSortByEnum
func GetListApisSortOrderEnumStringValues() []string
GetListApisSortOrderEnumStringValues Enumerates the set of values in String for ListApisSortOrderEnum
func GetListCertificatesSortByEnumStringValues() []string
GetListCertificatesSortByEnumStringValues Enumerates the set of values in String for ListCertificatesSortByEnum
func GetListCertificatesSortOrderEnumStringValues() []string
GetListCertificatesSortOrderEnumStringValues Enumerates the set of values in String for ListCertificatesSortOrderEnum
func GetListDeploymentsSortByEnumStringValues() []string
GetListDeploymentsSortByEnumStringValues Enumerates the set of values in String for ListDeploymentsSortByEnum
func GetListDeploymentsSortOrderEnumStringValues() []string
GetListDeploymentsSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentsSortOrderEnum
func GetListGatewaysSortByEnumStringValues() []string
GetListGatewaysSortByEnumStringValues Enumerates the set of values in String for ListGatewaysSortByEnum
func GetListGatewaysSortOrderEnumStringValues() []string
GetListGatewaysSortOrderEnumStringValues Enumerates the set of values in String for ListGatewaysSortOrderEnum
func GetListSdkLanguageTypesSortByEnumStringValues() []string
GetListSdkLanguageTypesSortByEnumStringValues Enumerates the set of values in String for ListSdkLanguageTypesSortByEnum
func GetListSdkLanguageTypesSortOrderEnumStringValues() []string
GetListSdkLanguageTypesSortOrderEnumStringValues Enumerates the set of values in String for ListSdkLanguageTypesSortOrderEnum
func GetListSdksSortByEnumStringValues() []string
GetListSdksSortByEnumStringValues Enumerates the set of values in String for ListSdksSortByEnum
func GetListSdksSortOrderEnumStringValues() []string
GetListSdksSortOrderEnumStringValues Enumerates the set of values in String for ListSdksSortOrderEnum
func GetListSubscribersSortByEnumStringValues() []string
GetListSubscribersSortByEnumStringValues Enumerates the set of values in String for ListSubscribersSortByEnum
func GetListSubscribersSortOrderEnumStringValues() []string
GetListSubscribersSortOrderEnumStringValues Enumerates the set of values in String for ListSubscribersSortOrderEnum
func GetListUsagePlansSortByEnumStringValues() []string
GetListUsagePlansSortByEnumStringValues Enumerates the set of values in String for ListUsagePlansSortByEnum
func GetListUsagePlansSortOrderEnumStringValues() []string
GetListUsagePlansSortOrderEnumStringValues Enumerates the set of values in String for ListUsagePlansSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumStringValues() []string
GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumStringValues Enumerates the set of values in String for OAuth2ResponseValidationFailurePolicyResponseTypeEnum
func GetPublicKeySetTypeEnumStringValues() []string
GetPublicKeySetTypeEnumStringValues Enumerates the set of values in String for PublicKeySetTypeEnum
func GetQueryParameterValidationRequestPolicyValidationModeEnumStringValues() []string
GetQueryParameterValidationRequestPolicyValidationModeEnumStringValues Enumerates the set of values in String for QueryParameterValidationRequestPolicyValidationModeEnum
func GetQuotaOperationOnBreachEnumStringValues() []string
GetQuotaOperationOnBreachEnumStringValues Enumerates the set of values in String for QuotaOperationOnBreachEnum
func GetQuotaResetPolicyEnumStringValues() []string
GetQuotaResetPolicyEnumStringValues Enumerates the set of values in String for QuotaResetPolicyEnum
func GetQuotaUnitEnumStringValues() []string
GetQuotaUnitEnumStringValues Enumerates the set of values in String for QuotaUnitEnum
func GetRateLimitUnitEnumStringValues() []string
GetRateLimitUnitEnumStringValues Enumerates the set of values in String for RateLimitUnitEnum
func GetRateLimitingPolicyRateKeyEnumStringValues() []string
GetRateLimitingPolicyRateKeyEnumStringValues Enumerates the set of values in String for RateLimitingPolicyRateKeyEnum
func GetResponseCacheDetailsTypeEnumStringValues() []string
GetResponseCacheDetailsTypeEnumStringValues Enumerates the set of values in String for ResponseCacheDetailsTypeEnum
func GetResponseCacheLookupPolicyTypeEnumStringValues() []string
GetResponseCacheLookupPolicyTypeEnumStringValues Enumerates the set of values in String for ResponseCacheLookupPolicyTypeEnum
func GetResponseCacheStorePolicyTypeEnumStringValues() []string
GetResponseCacheStorePolicyTypeEnumStringValues Enumerates the set of values in String for ResponseCacheStorePolicyTypeEnum
func GetRouteAuthorizationPolicyTypeEnumStringValues() []string
GetRouteAuthorizationPolicyTypeEnumStringValues Enumerates the set of values in String for RouteAuthorizationPolicyTypeEnum
func GetSdkLanguageOptionalParametersInputTypeEnumStringValues() []string
GetSdkLanguageOptionalParametersInputTypeEnumStringValues Enumerates the set of values in String for SdkLanguageOptionalParametersInputTypeEnum
func GetSdkLifecycleStateEnumStringValues() []string
GetSdkLifecycleStateEnumStringValues Enumerates the set of values in String for SdkLifecycleStateEnum
func GetSelectionSourcePolicyTypeEnumStringValues() []string
GetSelectionSourcePolicyTypeEnumStringValues Enumerates the set of values in String for SelectionSourcePolicyTypeEnum
func GetSetHeaderPolicyItemIfExistsEnumStringValues() []string
GetSetHeaderPolicyItemIfExistsEnumStringValues Enumerates the set of values in String for SetHeaderPolicyItemIfExistsEnum
func GetSetQueryParameterPolicyItemIfExistsEnumStringValues() []string
GetSetQueryParameterPolicyItemIfExistsEnumStringValues Enumerates the set of values in String for SetQueryParameterPolicyItemIfExistsEnum
func GetSourceUriDetailsTypeEnumStringValues() []string
GetSourceUriDetailsTypeEnumStringValues Enumerates the set of values in String for SourceUriDetailsTypeEnum
func GetStaticPublicKeyFormatEnumStringValues() []string
GetStaticPublicKeyFormatEnumStringValues Enumerates the set of values in String for StaticPublicKeyFormatEnum
func GetSubscriberLifecycleStateEnumStringValues() []string
GetSubscriberLifecycleStateEnumStringValues Enumerates the set of values in String for SubscriberLifecycleStateEnum
func GetTokenAuthenticationValidationPolicyTypeEnumStringValues() []string
GetTokenAuthenticationValidationPolicyTypeEnumStringValues Enumerates the set of values in String for TokenAuthenticationValidationPolicyTypeEnum
func GetUsagePlanLifecycleStateEnumStringValues() []string
GetUsagePlanLifecycleStateEnumStringValues Enumerates the set of values in String for UsagePlanLifecycleStateEnum
func GetValidationFailurePolicyTypeEnumStringValues() []string
GetValidationFailurePolicyTypeEnumStringValues Enumerates the set of values in String for ValidationFailurePolicyTypeEnum
func GetValidationRequestPolicyValidationModeEnumStringValues() []string
GetValidationRequestPolicyValidationModeEnumStringValues Enumerates the set of values in String for ValidationRequestPolicyValidationModeEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
AccessLogPolicy Configures the logging policies for the access logs of an API Deployment.
type AccessLogPolicy struct {
// Enables pushing of access logs to the legacy OCI Object Storage log archival bucket.
// Oracle recommends using the OCI Logging service to enable, retrieve, and query access logs
// for an API Deployment. If there is an active log object for the API Deployment and its
// category is set to 'access' in OCI Logging service, the logs will not be uploaded to the
// legacy OCI Object Storage log archival bucket.
// Please note that the functionality to push to the legacy OCI Object Storage log
// archival bucket has been deprecated and will be removed in the future.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
}
func (m AccessLogPolicy) String() string
func (m AccessLogPolicy) ValidateEnumValue() (bool, error)
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
AdditionalValidationPolicy Additional JWT validation checks.
type AdditionalValidationPolicy struct {
// A list of parties that could have issued the token.
Issuers []string `mandatory:"false" json:"issuers"`
// The list of intended recipients for the token.
Audiences []string `mandatory:"false" json:"audiences"`
// A list of claims which should be validated to consider the token valid.
VerifyClaims []JsonWebTokenClaim `mandatory:"false" json:"verifyClaims"`
}
func (m AdditionalValidationPolicy) String() string
func (m AdditionalValidationPolicy) ValidateEnumValue() (bool, error)
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
AnonymousRouteAuthorizationPolicy For a type of ANONYMOUS, an authenticated API must have the "isAnonymousAccessAllowed" property set to "true" in the authentication policy.
type AnonymousRouteAuthorizationPolicy struct {
}
func (m AnonymousRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AnonymousRouteAuthorizationPolicy) String() string
func (m AnonymousRouteAuthorizationPolicy) ValidateEnumValue() (bool, error)
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
AnyOfRouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route.
type AnyOfRouteAuthorizationPolicy struct {
// A user whose scope includes any of these access ranges is allowed on
// this route. Access ranges are case-sensitive.
AllowedScope []string `mandatory:"true" json:"allowedScope"`
}
func (m AnyOfRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AnyOfRouteAuthorizationPolicy) String() string
func (m AnyOfRouteAuthorizationPolicy) ValidateEnumValue() (bool, error)
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
AnyOfSelectionKey When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a set of selection keys is used if the context variable in an incoming request exactly matches one of the keys in the set.
type AnyOfSelectionKey struct {
// Name assigned to the branch.
Name *string `mandatory:"true" json:"name"`
// Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.
IsDefault *bool `mandatory:"false" json:"isDefault"`
// The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set.
Values []string `mandatory:"false" json:"values"`
}
func (m AnyOfSelectionKey) GetIsDefault() *bool
GetIsDefault returns IsDefault
func (m AnyOfSelectionKey) GetName() *string
GetName returns Name
func (m AnyOfSelectionKey) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AnyOfSelectionKey) String() string
func (m AnyOfSelectionKey) ValidateEnumValue() (bool, error)
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
Api An API is simple container for an API Specification. For more information, see API Gateway Concepts (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).
type Api struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the API.
LifecycleState ApiLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current lifecycleState in more detail. For ACTIVE
// state it describes if the document has been validated and the possible values are:
// - 'New' for just updated API Specifications
// - 'Validating' for a document which is being validated.
// - 'Valid' the document has been validated without any errors or warnings
// - 'Warning' the document has been validated and contains warnings
// - 'Error' the document has been validated and contains errors
// - 'Failed' the document validation failed
// - 'Canceled' the document validation was canceled
// For other states it may provide more details like actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Type of API Specification file.
SpecificationType *string `mandatory:"false" json:"specificationType"`
// Status of each feature available from the API.
ValidationResults []ApiValidationResult `mandatory:"false" json:"validationResults"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Api) String() string
func (m Api) ValidateEnumValue() (bool, error)
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
ApiCollection Collection of API summaries.
type ApiCollection struct {
// API summaries.
Items []ApiSummary `mandatory:"true" json:"items"`
}
func (m ApiCollection) String() string
func (m ApiCollection) ValidateEnumValue() (bool, error)
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
ApiGatewayClient a client for ApiGateway
type ApiGatewayClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewApiGatewayClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ApiGatewayClient, err error)
NewApiGatewayClientWithConfigurationProvider Creates a new default ApiGateway client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewApiGatewayClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ApiGatewayClient, err error)
NewApiGatewayClientWithOboToken Creates a new default ApiGateway client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client ApiGatewayClient) ChangeApiCompartment(ctx context.Context, request ChangeApiCompartmentRequest) (response ChangeApiCompartmentResponse, err error)
ChangeApiCompartment Changes the API compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeApiCompartment.go.html to see an example of how to use ChangeApiCompartment API.
func (client ApiGatewayClient) ChangeCertificateCompartment(ctx context.Context, request ChangeCertificateCompartmentRequest) (response ChangeCertificateCompartmentResponse, err error)
ChangeCertificateCompartment Changes the certificate compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeCertificateCompartment.go.html to see an example of how to use ChangeCertificateCompartment API.
func (client *ApiGatewayClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ApiGatewayClient) CreateApi(ctx context.Context, request CreateApiRequest) (response CreateApiResponse, err error)
CreateApi Creates a new API.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateApi.go.html to see an example of how to use CreateApi API. A default retry strategy applies to this operation CreateApi()
func (client ApiGatewayClient) CreateCertificate(ctx context.Context, request CreateCertificateRequest) (response CreateCertificateResponse, err error)
CreateCertificate Creates a new Certificate.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateCertificate.go.html to see an example of how to use CreateCertificate API. A default retry strategy applies to this operation CreateCertificate()
func (client ApiGatewayClient) CreateSdk(ctx context.Context, request CreateSdkRequest) (response CreateSdkResponse, err error)
CreateSdk Creates a new SDK.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateSdk.go.html to see an example of how to use CreateSdk API. A default retry strategy applies to this operation CreateSdk()
func (client ApiGatewayClient) DeleteApi(ctx context.Context, request DeleteApiRequest) (response DeleteApiResponse, err error)
DeleteApi Deletes the API with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteApi.go.html to see an example of how to use DeleteApi API.
func (client ApiGatewayClient) DeleteCertificate(ctx context.Context, request DeleteCertificateRequest) (response DeleteCertificateResponse, err error)
DeleteCertificate Deletes the certificate with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteCertificate.go.html to see an example of how to use DeleteCertificate API.
func (client ApiGatewayClient) DeleteSdk(ctx context.Context, request DeleteSdkRequest) (response DeleteSdkResponse, err error)
DeleteSdk Deletes provided SDK.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteSdk.go.html to see an example of how to use DeleteSdk API.
func (client ApiGatewayClient) GetApi(ctx context.Context, request GetApiRequest) (response GetApiResponse, err error)
GetApi Gets an API by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetApi.go.html to see an example of how to use GetApi API. A default retry strategy applies to this operation GetApi()
func (client ApiGatewayClient) GetApiContent(ctx context.Context, request GetApiContentRequest) (response GetApiContentResponse, err error)
GetApiContent Get the raw API content.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetApiContent.go.html to see an example of how to use GetApiContent API. A default retry strategy applies to this operation GetApiContent()
func (client ApiGatewayClient) GetApiDeploymentSpecification(ctx context.Context, request GetApiDeploymentSpecificationRequest) (response GetApiDeploymentSpecificationResponse, err error)
GetApiDeploymentSpecification Gets an API Deployment specification by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetApiDeploymentSpecification.go.html to see an example of how to use GetApiDeploymentSpecification API. A default retry strategy applies to this operation GetApiDeploymentSpecification()
func (client ApiGatewayClient) GetApiValidations(ctx context.Context, request GetApiValidationsRequest) (response GetApiValidationsResponse, err error)
GetApiValidations Gets the API validation results.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetApiValidations.go.html to see an example of how to use GetApiValidations API. A default retry strategy applies to this operation GetApiValidations()
func (client ApiGatewayClient) GetCertificate(ctx context.Context, request GetCertificateRequest) (response GetCertificateResponse, err error)
GetCertificate Gets a certificate by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetCertificate.go.html to see an example of how to use GetCertificate API. A default retry strategy applies to this operation GetCertificate()
func (client ApiGatewayClient) GetSdk(ctx context.Context, request GetSdkRequest) (response GetSdkResponse, err error)
GetSdk Return object store downloadable URL and metadata.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetSdk.go.html to see an example of how to use GetSdk API. A default retry strategy applies to this operation GetSdk()
func (client ApiGatewayClient) ListApis(ctx context.Context, request ListApisRequest) (response ListApisResponse, err error)
ListApis Returns a list of APIs.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListApis.go.html to see an example of how to use ListApis API. A default retry strategy applies to this operation ListApis()
func (client ApiGatewayClient) ListCertificates(ctx context.Context, request ListCertificatesRequest) (response ListCertificatesResponse, err error)
ListCertificates Returns a list of certificates.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListCertificates.go.html to see an example of how to use ListCertificates API. A default retry strategy applies to this operation ListCertificates()
func (client ApiGatewayClient) ListSdkLanguageTypes(ctx context.Context, request ListSdkLanguageTypesRequest) (response ListSdkLanguageTypesResponse, err error)
ListSdkLanguageTypes Lists programming languages in which SDK can be generated.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListSdkLanguageTypes.go.html to see an example of how to use ListSdkLanguageTypes API. A default retry strategy applies to this operation ListSdkLanguageTypes()
func (client ApiGatewayClient) ListSdks(ctx context.Context, request ListSdksRequest) (response ListSdksResponse, err error)
ListSdks Returns list of generated SDKs.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListSdks.go.html to see an example of how to use ListSdks API. A default retry strategy applies to this operation ListSdks()
func (client *ApiGatewayClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ApiGatewayClient) UpdateApi(ctx context.Context, request UpdateApiRequest) (response UpdateApiResponse, err error)
UpdateApi Updates the API with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateApi.go.html to see an example of how to use UpdateApi API.
func (client ApiGatewayClient) UpdateCertificate(ctx context.Context, request UpdateCertificateRequest) (response UpdateCertificateResponse, err error)
UpdateCertificate Updates a certificate with the given identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateCertificate.go.html to see an example of how to use UpdateCertificate API.
func (client ApiGatewayClient) UpdateSdk(ctx context.Context, request UpdateSdkRequest) (response UpdateSdkResponse, err error)
UpdateSdk Updates the SDK with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateSdk.go.html to see an example of how to use UpdateSdk API.
ApiLifecycleStateEnum Enum with underlying type: string
type ApiLifecycleStateEnum string
Set of constants representing the allowable values for ApiLifecycleStateEnum
const (
ApiLifecycleStateCreating ApiLifecycleStateEnum = "CREATING"
ApiLifecycleStateActive ApiLifecycleStateEnum = "ACTIVE"
ApiLifecycleStateUpdating ApiLifecycleStateEnum = "UPDATING"
ApiLifecycleStateDeleting ApiLifecycleStateEnum = "DELETING"
ApiLifecycleStateDeleted ApiLifecycleStateEnum = "DELETED"
ApiLifecycleStateFailed ApiLifecycleStateEnum = "FAILED"
)
func GetApiLifecycleStateEnumValues() []ApiLifecycleStateEnum
GetApiLifecycleStateEnumValues Enumerates the set of values for ApiLifecycleStateEnum
func GetMappingApiLifecycleStateEnum(val string) (ApiLifecycleStateEnum, bool)
GetMappingApiLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ApiSpecification The logical configuration of the API exposed by a deployment.
type ApiSpecification struct {
RequestPolicies *ApiSpecificationRequestPolicies `mandatory:"false" json:"requestPolicies"`
LoggingPolicies *ApiSpecificationLoggingPolicies `mandatory:"false" json:"loggingPolicies"`
// A list of routes that this API exposes.
Routes []ApiSpecificationRoute `mandatory:"false" json:"routes"`
}
func (m ApiSpecification) String() string
func (m ApiSpecification) ValidateEnumValue() (bool, error)
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
ApiSpecificationLoggingPolicies Policies controlling the pushing of logs to OCI Public Logging.
type ApiSpecificationLoggingPolicies struct {
AccessLog *AccessLogPolicy `mandatory:"false" json:"accessLog"`
ExecutionLog *ExecutionLogPolicy `mandatory:"false" json:"executionLog"`
}
func (m ApiSpecificationLoggingPolicies) String() string
func (m ApiSpecificationLoggingPolicies) ValidateEnumValue() (bool, error)
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
ApiSpecificationRequestPolicies Global behavior applied to all requests received by the API.
type ApiSpecificationRequestPolicies struct {
Authentication AuthenticationPolicy `mandatory:"false" json:"authentication"`
RateLimiting *RateLimitingPolicy `mandatory:"false" json:"rateLimiting"`
Cors *CorsPolicy `mandatory:"false" json:"cors"`
MutualTls *MutualTlsDetails `mandatory:"false" json:"mutualTls"`
UsagePlans *UsagePlansPolicy `mandatory:"false" json:"usagePlans"`
DynamicAuthentication *DynamicAuthenticationPolicy `mandatory:"false" json:"dynamicAuthentication"`
}
func (m ApiSpecificationRequestPolicies) String() string
func (m *ApiSpecificationRequestPolicies) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ApiSpecificationRequestPolicies) ValidateEnumValue() (bool, error)
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
ApiSpecificationRoute A single route that forwards requests to a particular backend and may contain some additional policies.
type ApiSpecificationRoute struct {
// A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers
// to allow wildcard and parameterized matching.
Path *string `mandatory:"true" json:"path"`
Backend ApiSpecificationRouteBackend `mandatory:"true" json:"backend"`
// A list of allowed methods on this route.
Methods []ApiSpecificationRouteMethodsEnum `mandatory:"false" json:"methods,omitempty"`
RequestPolicies *ApiSpecificationRouteRequestPolicies `mandatory:"false" json:"requestPolicies"`
ResponsePolicies *ApiSpecificationRouteResponsePolicies `mandatory:"false" json:"responsePolicies"`
LoggingPolicies *ApiSpecificationLoggingPolicies `mandatory:"false" json:"loggingPolicies"`
}
func (m ApiSpecificationRoute) String() string
func (m *ApiSpecificationRoute) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ApiSpecificationRoute) ValidateEnumValue() (bool, error)
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
ApiSpecificationRouteBackend The backend to forward requests to.
type ApiSpecificationRouteBackend interface {
}
ApiSpecificationRouteBackendTypeEnum Enum with underlying type: string
type ApiSpecificationRouteBackendTypeEnum string
Set of constants representing the allowable values for ApiSpecificationRouteBackendTypeEnum
const (
ApiSpecificationRouteBackendTypeOracleFunctionsBackend ApiSpecificationRouteBackendTypeEnum = "ORACLE_FUNCTIONS_BACKEND"
ApiSpecificationRouteBackendTypeHttpBackend ApiSpecificationRouteBackendTypeEnum = "HTTP_BACKEND"
ApiSpecificationRouteBackendTypeStockResponseBackend ApiSpecificationRouteBackendTypeEnum = "STOCK_RESPONSE_BACKEND"
ApiSpecificationRouteBackendTypeDynamicRoutingBackend ApiSpecificationRouteBackendTypeEnum = "DYNAMIC_ROUTING_BACKEND"
ApiSpecificationRouteBackendTypeOauth2LogoutBackend ApiSpecificationRouteBackendTypeEnum = "OAUTH2_LOGOUT_BACKEND"
)
func GetApiSpecificationRouteBackendTypeEnumValues() []ApiSpecificationRouteBackendTypeEnum
GetApiSpecificationRouteBackendTypeEnumValues Enumerates the set of values for ApiSpecificationRouteBackendTypeEnum
func GetMappingApiSpecificationRouteBackendTypeEnum(val string) (ApiSpecificationRouteBackendTypeEnum, bool)
GetMappingApiSpecificationRouteBackendTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ApiSpecificationRouteMethodsEnum Enum with underlying type: string
type ApiSpecificationRouteMethodsEnum string
Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum
const (
ApiSpecificationRouteMethodsAny ApiSpecificationRouteMethodsEnum = "ANY"
ApiSpecificationRouteMethodsHead ApiSpecificationRouteMethodsEnum = "HEAD"
ApiSpecificationRouteMethodsGet ApiSpecificationRouteMethodsEnum = "GET"
ApiSpecificationRouteMethodsPost ApiSpecificationRouteMethodsEnum = "POST"
ApiSpecificationRouteMethodsPut ApiSpecificationRouteMethodsEnum = "PUT"
ApiSpecificationRouteMethodsPatch ApiSpecificationRouteMethodsEnum = "PATCH"
ApiSpecificationRouteMethodsDelete ApiSpecificationRouteMethodsEnum = "DELETE"
ApiSpecificationRouteMethodsOptions ApiSpecificationRouteMethodsEnum = "OPTIONS"
)
func GetApiSpecificationRouteMethodsEnumValues() []ApiSpecificationRouteMethodsEnum
GetApiSpecificationRouteMethodsEnumValues Enumerates the set of values for ApiSpecificationRouteMethodsEnum
func GetMappingApiSpecificationRouteMethodsEnum(val string) (ApiSpecificationRouteMethodsEnum, bool)
GetMappingApiSpecificationRouteMethodsEnum performs case Insensitive comparison on enum value and return the desired enum
ApiSpecificationRouteRequestPolicies Behavior applied to any requests received by the API on this route.
type ApiSpecificationRouteRequestPolicies struct {
Authorization RouteAuthorizationPolicy `mandatory:"false" json:"authorization"`
Cors *CorsPolicy `mandatory:"false" json:"cors"`
QueryParameterValidations *QueryParameterValidationRequestPolicy `mandatory:"false" json:"queryParameterValidations"`
HeaderValidations *HeaderValidationRequestPolicy `mandatory:"false" json:"headerValidations"`
BodyValidation *BodyValidationRequestPolicy `mandatory:"false" json:"bodyValidation"`
HeaderTransformations *HeaderTransformationPolicy `mandatory:"false" json:"headerTransformations"`
QueryParameterTransformations *QueryParameterTransformationPolicy `mandatory:"false" json:"queryParameterTransformations"`
ResponseCacheLookup ResponseCacheLookupPolicy `mandatory:"false" json:"responseCacheLookup"`
}
func (m ApiSpecificationRouteRequestPolicies) String() string
func (m *ApiSpecificationRouteRequestPolicies) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ApiSpecificationRouteRequestPolicies) ValidateEnumValue() (bool, error)
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
ApiSpecificationRouteResponsePolicies Behavior applied to any responses sent by the API for requests on this route.
type ApiSpecificationRouteResponsePolicies struct {
HeaderTransformations *HeaderTransformationPolicy `mandatory:"false" json:"headerTransformations"`
ResponseCacheStore ResponseCacheStorePolicy `mandatory:"false" json:"responseCacheStore"`
}
func (m ApiSpecificationRouteResponsePolicies) String() string
func (m *ApiSpecificationRouteResponsePolicies) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ApiSpecificationRouteResponsePolicies) ValidateEnumValue() (bool, error)
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
ApiSummary A summary of the API.
type ApiSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the API.
LifecycleState ApiSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current lifecycleState in more detail. For ACTIVE
// state it describes if the document has been validated and the possible values are:
// - 'New' for just updated API Specifications
// - 'Validating' for a document which is being validated.
// - 'Valid' the document has been validated without any errors or warnings
// - 'Warning' the document has been validated and contains warnings
// - 'Error' the document has been validated and contains errors
// - 'Failed' the document validation failed
// - 'Canceled' the document validation was canceled
// For other states it may provide more details like actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Type of API Specification file.
SpecificationType *string `mandatory:"false" json:"specificationType"`
// Status of each feature available from the API.
ValidationResults []ApiValidationResult `mandatory:"false" json:"validationResults"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ApiSummary) String() string
func (m ApiSummary) ValidateEnumValue() (bool, error)
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
ApiSummaryLifecycleStateEnum Enum with underlying type: string
type ApiSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ApiSummaryLifecycleStateEnum
const (
ApiSummaryLifecycleStateCreating ApiSummaryLifecycleStateEnum = "CREATING"
ApiSummaryLifecycleStateActive ApiSummaryLifecycleStateEnum = "ACTIVE"
ApiSummaryLifecycleStateUpdating ApiSummaryLifecycleStateEnum = "UPDATING"
ApiSummaryLifecycleStateDeleting ApiSummaryLifecycleStateEnum = "DELETING"
ApiSummaryLifecycleStateDeleted ApiSummaryLifecycleStateEnum = "DELETED"
ApiSummaryLifecycleStateFailed ApiSummaryLifecycleStateEnum = "FAILED"
)
func GetApiSummaryLifecycleStateEnumValues() []ApiSummaryLifecycleStateEnum
GetApiSummaryLifecycleStateEnumValues Enumerates the set of values for ApiSummaryLifecycleStateEnum
func GetMappingApiSummaryLifecycleStateEnum(val string) (ApiSummaryLifecycleStateEnum, bool)
GetMappingApiSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ApiValidationDetail Detail of a single error or warning.
type ApiValidationDetail struct {
// Description of the warning/error.
Msg *string `mandatory:"false" json:"msg"`
// Severity of the issue.
Severity ApiValidationDetailSeverityEnum `mandatory:"false" json:"severity,omitempty"`
// Position of the issue in the specification file (line, column).
Src [][]float32 `mandatory:"false" json:"src"`
}
func (m ApiValidationDetail) String() string
func (m ApiValidationDetail) ValidateEnumValue() (bool, error)
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
ApiValidationDetailSeverityEnum Enum with underlying type: string
type ApiValidationDetailSeverityEnum string
Set of constants representing the allowable values for ApiValidationDetailSeverityEnum
const (
ApiValidationDetailSeverityInfo ApiValidationDetailSeverityEnum = "INFO"
ApiValidationDetailSeverityWarning ApiValidationDetailSeverityEnum = "WARNING"
ApiValidationDetailSeverityError ApiValidationDetailSeverityEnum = "ERROR"
)
func GetApiValidationDetailSeverityEnumValues() []ApiValidationDetailSeverityEnum
GetApiValidationDetailSeverityEnumValues Enumerates the set of values for ApiValidationDetailSeverityEnum
func GetMappingApiValidationDetailSeverityEnum(val string) (ApiValidationDetailSeverityEnum, bool)
GetMappingApiValidationDetailSeverityEnum performs case Insensitive comparison on enum value and return the desired enum
ApiValidationDetails Detail of an error or warning.
type ApiValidationDetails struct {
// Name of the validation.
Name *string `mandatory:"true" json:"name"`
// Result of the validation.
Result ApiValidationDetailsResultEnum `mandatory:"true" json:"result"`
// Details of validation.
Details []ApiValidationDetail `mandatory:"false" json:"details"`
}
func (m ApiValidationDetails) String() string
func (m ApiValidationDetails) ValidateEnumValue() (bool, error)
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
ApiValidationDetailsResultEnum Enum with underlying type: string
type ApiValidationDetailsResultEnum string
Set of constants representing the allowable values for ApiValidationDetailsResultEnum
const (
ApiValidationDetailsResultError ApiValidationDetailsResultEnum = "ERROR"
ApiValidationDetailsResultWarning ApiValidationDetailsResultEnum = "WARNING"
ApiValidationDetailsResultOk ApiValidationDetailsResultEnum = "OK"
ApiValidationDetailsResultFailed ApiValidationDetailsResultEnum = "FAILED"
)
func GetApiValidationDetailsResultEnumValues() []ApiValidationDetailsResultEnum
GetApiValidationDetailsResultEnumValues Enumerates the set of values for ApiValidationDetailsResultEnum
func GetMappingApiValidationDetailsResultEnum(val string) (ApiValidationDetailsResultEnum, bool)
GetMappingApiValidationDetailsResultEnum performs case Insensitive comparison on enum value and return the desired enum
ApiValidationResult The result of single validation.
type ApiValidationResult struct {
// Name of the validation.
Name *string `mandatory:"true" json:"name"`
// Result of the validation.
Result ApiValidationResultResultEnum `mandatory:"true" json:"result"`
}
func (m ApiValidationResult) String() string
func (m ApiValidationResult) ValidateEnumValue() (bool, error)
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
ApiValidationResultResultEnum Enum with underlying type: string
type ApiValidationResultResultEnum string
Set of constants representing the allowable values for ApiValidationResultResultEnum
const (
ApiValidationResultResultError ApiValidationResultResultEnum = "ERROR"
ApiValidationResultResultWarning ApiValidationResultResultEnum = "WARNING"
ApiValidationResultResultOk ApiValidationResultResultEnum = "OK"
ApiValidationResultResultFailed ApiValidationResultResultEnum = "FAILED"
)
func GetApiValidationResultResultEnumValues() []ApiValidationResultResultEnum
GetApiValidationResultResultEnumValues Enumerates the set of values for ApiValidationResultResultEnum
func GetMappingApiValidationResultResultEnum(val string) (ApiValidationResultResultEnum, bool)
GetMappingApiValidationResultResultEnum performs case Insensitive comparison on enum value and return the desired enum
ApiValidations The result of validations conducted on the API.
type ApiValidations struct {
// API validation results.
Validations []ApiValidationDetails `mandatory:"true" json:"validations"`
}
func (m ApiValidations) String() string
func (m ApiValidations) ValidateEnumValue() (bool, error)
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
AuthenticationOnlyRouteAuthorizationPolicy Only authentication is performed for the request and authorization is skipped.
type AuthenticationOnlyRouteAuthorizationPolicy struct {
}
func (m AuthenticationOnlyRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AuthenticationOnlyRouteAuthorizationPolicy) String() string
func (m AuthenticationOnlyRouteAuthorizationPolicy) ValidateEnumValue() (bool, error)
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
AuthenticationPolicy Information on how to authenticate incoming requests.
type AuthenticationPolicy interface {
// Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS
// route authorization.
GetIsAnonymousAccessAllowed() *bool
}
AuthenticationPolicyTypeEnum Enum with underlying type: string
type AuthenticationPolicyTypeEnum string
Set of constants representing the allowable values for AuthenticationPolicyTypeEnum
const (
AuthenticationPolicyTypeCustomAuthentication AuthenticationPolicyTypeEnum = "CUSTOM_AUTHENTICATION"
AuthenticationPolicyTypeJwtAuthentication AuthenticationPolicyTypeEnum = "JWT_AUTHENTICATION"
AuthenticationPolicyTypeTokenAuthentication AuthenticationPolicyTypeEnum = "TOKEN_AUTHENTICATION"
)
func GetAuthenticationPolicyTypeEnumValues() []AuthenticationPolicyTypeEnum
GetAuthenticationPolicyTypeEnumValues Enumerates the set of values for AuthenticationPolicyTypeEnum
func GetMappingAuthenticationPolicyTypeEnum(val string) (AuthenticationPolicyTypeEnum, bool)
GetMappingAuthenticationPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AuthenticationServerPolicy Policy for the details regarding each authentication server under dynamic authentication. We specify the value of selectors for which this authentication server must be selected for a request under keys. We specify the configuration details of authentication server under authenticationServerDetail.
type AuthenticationServerPolicy struct {
Key DynamicSelectionKey `mandatory:"true" json:"key"`
AuthenticationServerDetail AuthenticationPolicy `mandatory:"true" json:"authenticationServerDetail"`
}
func (m AuthenticationServerPolicy) String() string
func (m *AuthenticationServerPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AuthenticationServerPolicy) ValidateEnumValue() (bool, error)
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
BodyValidationRequestPolicy Validate the payload body of the incoming API requests on a specific route.
type BodyValidationRequestPolicy struct {
// The content of the request body. The key is a media type range (https://tools.ietf.org/html/rfc7231#appendix-D)
// subset restricted to the following schema
// key ::= (
// / ( "*" "/" "*" )
// / ( type "/" "*" )
// / ( type "/" subtype )
// )
// For requests that match multiple keys, only the most specific key is applicable.
// e.g. `text/plain` overrides `text/*`
Content map[string]ContentValidation `mandatory:"true" json:"content"`
// Validation behavior mode.
// In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response
// and not sent to the backend.
// In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request
// will follow the normal path.
// `DISABLED` type turns the validation off.
ValidationMode BodyValidationRequestPolicyValidationModeEnum `mandatory:"false" json:"validationMode,omitempty"`
// Determines if the request body is required in the request.
Required *bool `mandatory:"false" json:"required"`
}
func (m BodyValidationRequestPolicy) String() string
func (m *BodyValidationRequestPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m BodyValidationRequestPolicy) ValidateEnumValue() (bool, error)
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
BodyValidationRequestPolicyValidationModeEnum Enum with underlying type: string
type BodyValidationRequestPolicyValidationModeEnum string
Set of constants representing the allowable values for BodyValidationRequestPolicyValidationModeEnum
const (
BodyValidationRequestPolicyValidationModeEnforcing BodyValidationRequestPolicyValidationModeEnum = "ENFORCING"
BodyValidationRequestPolicyValidationModePermissive BodyValidationRequestPolicyValidationModeEnum = "PERMISSIVE"
BodyValidationRequestPolicyValidationModeDisabled BodyValidationRequestPolicyValidationModeEnum = "DISABLED"
)
func GetBodyValidationRequestPolicyValidationModeEnumValues() []BodyValidationRequestPolicyValidationModeEnum
GetBodyValidationRequestPolicyValidationModeEnumValues Enumerates the set of values for BodyValidationRequestPolicyValidationModeEnum
func GetMappingBodyValidationRequestPolicyValidationModeEnum(val string) (BodyValidationRequestPolicyValidationModeEnum, bool)
GetMappingBodyValidationRequestPolicyValidationModeEnum performs case Insensitive comparison on enum value and return the desired enum
CaBundle Reference to the CA bundle that should be used on the gateway
type CaBundle interface {
}
CaBundleTypeEnum Enum with underlying type: string
type CaBundleTypeEnum string
Set of constants representing the allowable values for CaBundleTypeEnum
const (
CaBundleTypeCaBundle CaBundleTypeEnum = "CA_BUNDLE"
CaBundleTypeCertificateAuthority CaBundleTypeEnum = "CERTIFICATE_AUTHORITY"
)
func GetCaBundleTypeEnumValues() []CaBundleTypeEnum
GetCaBundleTypeEnumValues Enumerates the set of values for CaBundleTypeEnum
func GetMappingCaBundleTypeEnum(val string) (CaBundleTypeEnum, bool)
GetMappingCaBundleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The ocid of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
Certificate A certificate contains information to be installed on a gateway to secure the traffic going through it. For more information, see API Gateway Concepts (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).
type Certificate struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The entity to be secured by the certificate and additional host names.
SubjectNames []string `mandatory:"true" json:"subjectNames"`
// The date and time the certificate will expire.
TimeNotValidAfter *common.SDKTime `mandatory:"true" json:"timeNotValidAfter"`
// The data of the leaf certificate in pem format.
Certificate *string `mandatory:"true" json:"certificate"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The intermediate certificate data associated with the certificate in pem format.
IntermediateCertificates *string `mandatory:"false" json:"intermediateCertificates"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the certificate.
LifecycleState CertificateLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Certificate) String() string
func (m Certificate) ValidateEnumValue() (bool, error)
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
CertificateCollection Collection of certificate summaries.
type CertificateCollection struct {
// Certificate summaries.
Items []CertificateSummary `mandatory:"true" json:"items"`
}
func (m CertificateCollection) String() string
func (m CertificateCollection) ValidateEnumValue() (bool, error)
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
CertificateLifecycleStateEnum Enum with underlying type: string
type CertificateLifecycleStateEnum string
Set of constants representing the allowable values for CertificateLifecycleStateEnum
const (
CertificateLifecycleStateCreating CertificateLifecycleStateEnum = "CREATING"
CertificateLifecycleStateActive CertificateLifecycleStateEnum = "ACTIVE"
CertificateLifecycleStateUpdating CertificateLifecycleStateEnum = "UPDATING"
CertificateLifecycleStateDeleting CertificateLifecycleStateEnum = "DELETING"
CertificateLifecycleStateDeleted CertificateLifecycleStateEnum = "DELETED"
CertificateLifecycleStateFailed CertificateLifecycleStateEnum = "FAILED"
)
func GetCertificateLifecycleStateEnumValues() []CertificateLifecycleStateEnum
GetCertificateLifecycleStateEnumValues Enumerates the set of values for CertificateLifecycleStateEnum
func GetMappingCertificateLifecycleStateEnum(val string) (CertificateLifecycleStateEnum, bool)
GetMappingCertificateLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
CertificateSummary A summary of the certificate.
type CertificateSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The entity to be secured by the certificate and additional host names.
SubjectNames []string `mandatory:"true" json:"subjectNames"`
// The date and time the certificate will expire.
TimeNotValidAfter *common.SDKTime `mandatory:"true" json:"timeNotValidAfter"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the certificate.
LifecycleState CertificateLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CertificateSummary) String() string
func (m CertificateSummary) ValidateEnumValue() (bool, error)
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
CertificatesCaBundle CA bundle from Certificates Service that should be used on the gateway for TLS validation
type CertificatesCaBundle struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
CaBundleId *string `mandatory:"false" json:"caBundleId"`
}
func (m CertificatesCaBundle) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CertificatesCaBundle) String() string
func (m CertificatesCaBundle) ValidateEnumValue() (bool, error)
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
CertificatesCertificateAuthority Certificate Authority from Certificates Service that should be used on the gateway for TLS validation
type CertificatesCertificateAuthority struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
CertificateAuthorityId *string `mandatory:"false" json:"certificateAuthorityId"`
}
func (m CertificatesCertificateAuthority) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CertificatesCertificateAuthority) String() string
func (m CertificatesCertificateAuthority) ValidateEnumValue() (bool, error)
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
ChangeApiCompartmentDetails The new compartment details for the API.
type ChangeApiCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeApiCompartmentDetails) String() string
func (m ChangeApiCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeApiCompartmentRequest wrapper for the ChangeApiCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeApiCompartment.go.html to see an example of how to use ChangeApiCompartmentRequest.
type ChangeApiCompartmentRequest struct {
// The ocid of the API.
ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`
// Details of the target compartment.
ChangeApiCompartmentDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request ChangeApiCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeApiCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeApiCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeApiCompartmentRequest) String() string
func (request ChangeApiCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeApiCompartmentResponse wrapper for the ChangeApiCompartment operation
type ChangeApiCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangeApiCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeApiCompartmentResponse) String() string
ChangeCertificateCompartmentDetails The new compartment details for the certificate.
type ChangeCertificateCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCertificateCompartmentDetails) String() string
func (m ChangeCertificateCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeCertificateCompartmentRequest wrapper for the ChangeCertificateCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeCertificateCompartment.go.html to see an example of how to use ChangeCertificateCompartmentRequest.
type ChangeCertificateCompartmentRequest struct {
// The ocid of the certificate.
CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`
// Details of the target compartment.
ChangeCertificateCompartmentDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request ChangeCertificateCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeCertificateCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeCertificateCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeCertificateCompartmentRequest) String() string
func (request ChangeCertificateCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeCertificateCompartmentResponse wrapper for the ChangeCertificateCompartment operation
type ChangeCertificateCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response ChangeCertificateCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeCertificateCompartmentResponse) String() string
ChangeDeploymentCompartmentDetails The new compartment details for the deployment.
type ChangeDeploymentCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDeploymentCompartmentDetails) String() string
func (m ChangeDeploymentCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeDeploymentCompartmentRequest wrapper for the ChangeDeploymentCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeDeploymentCompartment.go.html to see an example of how to use ChangeDeploymentCompartmentRequest.
type ChangeDeploymentCompartmentRequest struct {
// The ocid of the deployment.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// Details of the target compartment.
ChangeDeploymentCompartmentDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request ChangeDeploymentCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDeploymentCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDeploymentCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDeploymentCompartmentRequest) String() string
func (request ChangeDeploymentCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeDeploymentCompartmentResponse wrapper for the ChangeDeploymentCompartment operation
type ChangeDeploymentCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangeDeploymentCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDeploymentCompartmentResponse) String() string
ChangeGatewayCompartmentDetails The new compartment details for the gateway.
type ChangeGatewayCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeGatewayCompartmentDetails) String() string
func (m ChangeGatewayCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeGatewayCompartmentRequest wrapper for the ChangeGatewayCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeGatewayCompartment.go.html to see an example of how to use ChangeGatewayCompartmentRequest.
type ChangeGatewayCompartmentRequest struct {
// The ocid of the gateway.
GatewayId *string `mandatory:"true" contributesTo:"path" name:"gatewayId"`
// Details of the target compartment.
ChangeGatewayCompartmentDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request ChangeGatewayCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeGatewayCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeGatewayCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeGatewayCompartmentRequest) String() string
func (request ChangeGatewayCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeGatewayCompartmentResponse wrapper for the ChangeGatewayCompartment operation
type ChangeGatewayCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangeGatewayCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeGatewayCompartmentResponse) String() string
ChangeSubscriberCompartmentDetails The new compartment details for the subscriber.
type ChangeSubscriberCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeSubscriberCompartmentDetails) String() string
func (m ChangeSubscriberCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeSubscriberCompartmentRequest wrapper for the ChangeSubscriberCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeSubscriberCompartment.go.html to see an example of how to use ChangeSubscriberCompartmentRequest.
type ChangeSubscriberCompartmentRequest struct {
// The ocid of the subscriber.
SubscriberId *string `mandatory:"true" contributesTo:"path" name:"subscriberId"`
// Details of the target compartment.
ChangeSubscriberCompartmentDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request ChangeSubscriberCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeSubscriberCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSubscriberCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSubscriberCompartmentRequest) String() string
func (request ChangeSubscriberCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeSubscriberCompartmentResponse wrapper for the ChangeSubscriberCompartment operation
type ChangeSubscriberCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangeSubscriberCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSubscriberCompartmentResponse) String() string
ChangeUsagePlanCompartmentDetails The new compartment details for the usage plan.
type ChangeUsagePlanCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeUsagePlanCompartmentDetails) String() string
func (m ChangeUsagePlanCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeUsagePlanCompartmentRequest wrapper for the ChangeUsagePlanCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeUsagePlanCompartment.go.html to see an example of how to use ChangeUsagePlanCompartmentRequest.
type ChangeUsagePlanCompartmentRequest struct {
// The ocid of the usage plan.
UsagePlanId *string `mandatory:"true" contributesTo:"path" name:"usagePlanId"`
// Details of the target compartment.
ChangeUsagePlanCompartmentDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request ChangeUsagePlanCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeUsagePlanCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeUsagePlanCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeUsagePlanCompartmentRequest) String() string
func (request ChangeUsagePlanCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeUsagePlanCompartmentResponse wrapper for the ChangeUsagePlanCompartment operation
type ChangeUsagePlanCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response ChangeUsagePlanCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeUsagePlanCompartmentResponse) String() string
Client A Client.
type Client struct {
// The name of the client. Must be unique within a subscriber.
Name *string `mandatory:"true" json:"name"`
// The token for the client. Must be unique within a tenancy.
Token *string `mandatory:"true" json:"token"`
}
func (m Client) String() string
func (m Client) ValidateEnumValue() (bool, error)
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
ClientAppDetails Client App Credential details.
type ClientAppDetails interface {
}
ClientAppDetailsTypeEnum Enum with underlying type: string
type ClientAppDetailsTypeEnum string
Set of constants representing the allowable values for ClientAppDetailsTypeEnum
const (
ClientAppDetailsTypeValidationBlock ClientAppDetailsTypeEnum = "VALIDATION_BLOCK"
ClientAppDetailsTypeCustom ClientAppDetailsTypeEnum = "CUSTOM"
)
func GetClientAppDetailsTypeEnumValues() []ClientAppDetailsTypeEnum
GetClientAppDetailsTypeEnumValues Enumerates the set of values for ClientAppDetailsTypeEnum
func GetMappingClientAppDetailsTypeEnum(val string) (ClientAppDetailsTypeEnum, bool)
GetMappingClientAppDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ClientSummary A summary of a client.
type ClientSummary struct {
// The client name.
Name *string `mandatory:"true" json:"name"`
}
func (m ClientSummary) String() string
func (m ClientSummary) ValidateEnumValue() (bool, error)
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
ContentValidation Content validation properties.
type ContentValidation interface {
}
ContentValidationValidationTypeEnum Enum with underlying type: string
type ContentValidationValidationTypeEnum string
Set of constants representing the allowable values for ContentValidationValidationTypeEnum
const (
ContentValidationValidationTypeNone ContentValidationValidationTypeEnum = "NONE"
)
func GetContentValidationValidationTypeEnumValues() []ContentValidationValidationTypeEnum
GetContentValidationValidationTypeEnumValues Enumerates the set of values for ContentValidationValidationTypeEnum
func GetMappingContentValidationValidationTypeEnum(val string) (ContentValidationValidationTypeEnum, bool)
GetMappingContentValidationValidationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CorsPolicy Enable CORS (Cross-Origin-Resource-Sharing) request handling.
type CorsPolicy struct {
// The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will
// send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match
// any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the
// scheme, full hostname, and port if necessary.
AllowedOrigins []string `mandatory:"true" json:"allowedOrigins"`
// The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the
// Access-Control-Allow-Methods header. '*' will allow all methods.
AllowedMethods []string `mandatory:"false" json:"allowedMethods"`
// The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header.
// '*' will allow all headers.
AllowedHeaders []string `mandatory:"false" json:"allowedHeaders"`
// The list of headers that the client will be allowed to see from the response as indicated by the
// Access-Control-Expose-Headers header. '*' will expose all headers.
ExposedHeaders []string `mandatory:"false" json:"exposedHeaders"`
// Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
IsAllowCredentialsEnabled *bool `mandatory:"false" json:"isAllowCredentialsEnabled"`
// The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age
// if greater than 0.
MaxAgeInSeconds *int `mandatory:"false" json:"maxAgeInSeconds"`
}
func (m CorsPolicy) String() string
func (m CorsPolicy) ValidateEnumValue() (bool, error)
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
CreateApiDetails Information about the new API.
type CreateApiDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// API Specification content in json or yaml format
Content *string `mandatory:"false" json:"content"`
}
func (m CreateApiDetails) String() string
func (m CreateApiDetails) ValidateEnumValue() (bool, error)
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
CreateApiRequest wrapper for the CreateApi operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateApi.go.html to see an example of how to use CreateApiRequest.
type CreateApiRequest struct {
// Details for the new API.
CreateApiDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request id for tracing.
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
}
func (request CreateApiRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateApiRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateApiRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateApiRequest) String() string
func (request CreateApiRequest) ValidateEnumValue() (bool, error)
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
CreateApiResponse wrapper for the CreateApi operation
type CreateApiResponse struct {
// The underlying http response
RawResponse *http.Response
// The Api instance
Api `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
// Location of the resource.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateApiResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateApiResponse) String() string
CreateCertificateDetails Information about a new certificate.
type CreateCertificateDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The private key associated with the certificate in pem format.
PrivateKey *string `mandatory:"true" json:"privateKey"`
// The data of the leaf certificate in pem format.
Certificate *string `mandatory:"true" json:"certificate"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// The intermediate certificate data associated with the certificate in pem format.
IntermediateCertificates *string `mandatory:"false" json:"intermediateCertificates"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateCertificateDetails) String() string
func (m CreateCertificateDetails) ValidateEnumValue() (bool, error)
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
CreateCertificateRequest wrapper for the CreateCertificate operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateCertificate.go.html to see an example of how to use CreateCertificateRequest.
type CreateCertificateRequest struct {
// Details for the new certificate
CreateCertificateDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request id for tracing.
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
}
func (request CreateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCertificateRequest) String() string
func (request CreateCertificateRequest) ValidateEnumValue() (bool, error)
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
CreateCertificateResponse wrapper for the CreateCertificate operation
type CreateCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The Certificate instance
Certificate `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Location of the resource.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCertificateResponse) String() string
CreateDeploymentDetails Information about a new deployment.
type CreateDeploymentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
GatewayId *string `mandatory:"true" json:"gatewayId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A path on which to deploy all routes contained in the API
// deployment specification. For more information, see
// Deploying an API on an API Gateway by Creating an API
// Deployment (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).
PathPrefix *string `mandatory:"true" json:"pathPrefix"`
Specification *ApiSpecification `mandatory:"true" json:"specification"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDeploymentDetails) String() string
func (m CreateDeploymentDetails) ValidateEnumValue() (bool, error)
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
CreateDeploymentRequest wrapper for the CreateDeployment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateDeployment.go.html to see an example of how to use CreateDeploymentRequest.
type CreateDeploymentRequest struct {
// Details for the new deployment
CreateDeploymentDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request id for tracing.
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
}
func (request CreateDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDeploymentRequest) String() string
func (request CreateDeploymentRequest) ValidateEnumValue() (bool, error)
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
CreateDeploymentResponse wrapper for the CreateDeployment operation
type CreateDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The Deployment instance
Deployment `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
// Location of the resource.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDeploymentResponse) String() string
CreateGatewayDetails Information about the new gateway.
type CreateGatewayDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be
// accessible on a private IP address on the subnet.
// Example: `PUBLIC` or `PRIVATE`
EndpointType GatewayEndpointTypeEnum `mandatory:"true" json:"endpointType"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet in which
// related resources are created.
SubnetId *string `mandatory:"true" json:"subnetId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// An array of Network Security Groups OCIDs associated with this API Gateway.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
CertificateId *string `mandatory:"false" json:"certificateId"`
ResponseCacheDetails ResponseCacheDetails `mandatory:"false" json:"responseCacheDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// An array of CA bundles that should be used on the Gateway for TLS validation.
CaBundles []CaBundle `mandatory:"false" json:"caBundles"`
}
func (m CreateGatewayDetails) String() string
func (m *CreateGatewayDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateGatewayDetails) ValidateEnumValue() (bool, error)
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
CreateGatewayRequest wrapper for the CreateGateway operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateGateway.go.html to see an example of how to use CreateGatewayRequest.
type CreateGatewayRequest struct {
// Details for the new gateway.
CreateGatewayDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request id for tracing.
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
}
func (request CreateGatewayRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGatewayRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGatewayRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGatewayRequest) String() string
func (request CreateGatewayRequest) ValidateEnumValue() (bool, error)
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
CreateGatewayResponse wrapper for the CreateGateway operation
type CreateGatewayResponse struct {
// The underlying http response
RawResponse *http.Response
// The Gateway instance
Gateway `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
// Location of the resource.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateGatewayResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGatewayResponse) String() string
CreateSdkDetails Information about the new SDK.
type CreateSdkDetails struct {
// The string representing the target programming language for generating the SDK.
TargetLanguage *string `mandatory:"true" json:"targetLanguage"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of API resource
ApiId *string `mandatory:"true" json:"apiId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Additional optional configurations that can be passed to generate SDK Api.
// The applicable parameters are listed under "parameters" when "/sdkLanguageTypes" is called.
// Example: `{"configName": "configValue"}`
Parameters map[string]string `mandatory:"false" json:"parameters"`
}
func (m CreateSdkDetails) String() string
func (m CreateSdkDetails) ValidateEnumValue() (bool, error)
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
CreateSdkRequest wrapper for the CreateSdk operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateSdk.go.html to see an example of how to use CreateSdkRequest.
type CreateSdkRequest struct {
// Details for the new SDK.
CreateSdkDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request id for tracing.
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
}
func (request CreateSdkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSdkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSdkRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSdkRequest) String() string
func (request CreateSdkRequest) ValidateEnumValue() (bool, error)
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
CreateSdkResponse wrapper for the CreateSdk operation
type CreateSdkResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sdk instance
Sdk `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
// Location of the resource.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateSdkResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSdkResponse) String() string
CreateSubscriberDetails Information about a new subscriber.
type CreateSubscriberDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The clients belonging to this subscriber.
Clients []Client `mandatory:"true" json:"clients"`
// An array of OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)s of usage
// plan resources.
UsagePlans []string `mandatory:"true" json:"usagePlans"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateSubscriberDetails) String() string
func (m CreateSubscriberDetails) ValidateEnumValue() (bool, error)
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
CreateSubscriberRequest wrapper for the CreateSubscriber operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateSubscriber.go.html to see an example of how to use CreateSubscriberRequest.
type CreateSubscriberRequest struct {
// Details for the new subscriber.
CreateSubscriberDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request id for tracing.
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
}
func (request CreateSubscriberRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSubscriberRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSubscriberRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSubscriberRequest) String() string
func (request CreateSubscriberRequest) ValidateEnumValue() (bool, error)
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
CreateSubscriberResponse wrapper for the CreateSubscriber operation
type CreateSubscriberResponse struct {
// The underlying http response
RawResponse *http.Response
// The Subscriber instance
Subscriber `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
// Location of the resource.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateSubscriberResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSubscriberResponse) String() string
CreateUsagePlanDetails Information about a new usage plan.
type CreateUsagePlanDetails struct {
// A collection of entitlements to assign to the newly created usage plan.
Entitlements []Entitlement `mandatory:"true" json:"entitlements"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateUsagePlanDetails) String() string
func (m CreateUsagePlanDetails) ValidateEnumValue() (bool, error)
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
CreateUsagePlanRequest wrapper for the CreateUsagePlan operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateUsagePlan.go.html to see an example of how to use CreateUsagePlanRequest.
type CreateUsagePlanRequest struct {
// Details for the new usage plan.
CreateUsagePlanDetails `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. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request id for tracing.
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
}
func (request CreateUsagePlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateUsagePlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateUsagePlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateUsagePlanRequest) String() string
func (request CreateUsagePlanRequest) ValidateEnumValue() (bool, error)
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
CreateUsagePlanResponse wrapper for the CreateUsagePlan operation
type CreateUsagePlanResponse struct {
// The underlying http response
RawResponse *http.Response
// The UsagePlan instance
UsagePlan `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
// Location of the resource.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateUsagePlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateUsagePlanResponse) String() string
CustomAuthenticationPolicy Use a function to validate a custom header or query parameter sent with the request authentication. A valid policy must specify either tokenHeader or tokenQueryParam.
type CustomAuthenticationPolicy struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.
FunctionId *string `mandatory:"true" json:"functionId"`
// Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS
// route authorization.
IsAnonymousAccessAllowed *bool `mandatory:"false" json:"isAnonymousAccessAllowed"`
// The name of the header containing the authentication token.
TokenHeader *string `mandatory:"false" json:"tokenHeader"`
// The name of the query parameter containing the authentication token.
TokenQueryParam *string `mandatory:"false" json:"tokenQueryParam"`
// A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression.
// Example: `{"foo": "request.header[abc]"}`
Parameters map[string]string `mandatory:"false" json:"parameters"`
// A list of keys from "parameters" attribute value whose values will be added to the cache key.
CacheKey []string `mandatory:"false" json:"cacheKey"`
ValidationFailurePolicy ValidationFailurePolicy `mandatory:"false" json:"validationFailurePolicy"`
}
func (m CustomAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool
GetIsAnonymousAccessAllowed returns IsAnonymousAccessAllowed
func (m CustomAuthenticationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CustomAuthenticationPolicy) String() string
func (m *CustomAuthenticationPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CustomAuthenticationPolicy) ValidateEnumValue() (bool, error)
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
CustomClientAppDetails Client App Credentials to be provided again.
type CustomClientAppDetails struct {
// Client ID for the OAuth2/OIDC app.
ClientId *string `mandatory:"true" json:"clientId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.
ClientSecretId *string `mandatory:"true" json:"clientSecretId"`
// The version number of the client secret to use.
ClientSecretVersionNumber *int64 `mandatory:"true" json:"clientSecretVersionNumber"`
}
func (m CustomClientAppDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CustomClientAppDetails) String() string
func (m CustomClientAppDetails) ValidateEnumValue() (bool, error)
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
DeleteApiRequest wrapper for the DeleteApi operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteApi.go.html to see an example of how to use DeleteApiRequest.
type DeleteApiRequest struct {
// The ocid of the API.
ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request DeleteApiRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteApiRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteApiRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteApiRequest) String() string
func (request DeleteApiRequest) ValidateEnumValue() (bool, error)
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
DeleteApiResponse wrapper for the DeleteApi operation
type DeleteApiResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteApiResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteApiResponse) String() string
DeleteCertificateRequest wrapper for the DeleteCertificate operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteCertificate.go.html to see an example of how to use DeleteCertificateRequest.
type DeleteCertificateRequest struct {
// The ocid of the certificate.
CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request DeleteCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCertificateRequest) String() string
func (request DeleteCertificateRequest) ValidateEnumValue() (bool, error)
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
DeleteCertificateResponse wrapper for the DeleteCertificate operation
type DeleteCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCertificateResponse) String() string
DeleteDeploymentRequest wrapper for the DeleteDeployment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteDeployment.go.html to see an example of how to use DeleteDeploymentRequest.
type DeleteDeploymentRequest struct {
// The ocid of the deployment.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request DeleteDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDeploymentRequest) String() string
func (request DeleteDeploymentRequest) ValidateEnumValue() (bool, error)
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
DeleteDeploymentResponse wrapper for the DeleteDeployment operation
type DeleteDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDeploymentResponse) String() string
DeleteGatewayRequest wrapper for the DeleteGateway operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteGateway.go.html to see an example of how to use DeleteGatewayRequest.
type DeleteGatewayRequest struct {
// The ocid of the gateway.
GatewayId *string `mandatory:"true" contributesTo:"path" name:"gatewayId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request DeleteGatewayRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteGatewayRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteGatewayRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteGatewayRequest) String() string
func (request DeleteGatewayRequest) ValidateEnumValue() (bool, error)
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
DeleteGatewayResponse wrapper for the DeleteGateway operation
type DeleteGatewayResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteGatewayResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteGatewayResponse) String() string
DeleteSdkRequest wrapper for the DeleteSdk operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteSdk.go.html to see an example of how to use DeleteSdkRequest.
type DeleteSdkRequest struct {
// The ocid of the SDK.
SdkId *string `mandatory:"true" contributesTo:"path" name:"sdkId"`
// The client request id for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 DeleteSdkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSdkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSdkRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSdkRequest) String() string
func (request DeleteSdkRequest) ValidateEnumValue() (bool, error)
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
DeleteSdkResponse wrapper for the DeleteSdk operation
type DeleteSdkResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteSdkResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSdkResponse) String() string
DeleteSubscriberRequest wrapper for the DeleteSubscriber operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteSubscriber.go.html to see an example of how to use DeleteSubscriberRequest.
type DeleteSubscriberRequest struct {
// The ocid of the subscriber.
SubscriberId *string `mandatory:"true" contributesTo:"path" name:"subscriberId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request DeleteSubscriberRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSubscriberRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSubscriberRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSubscriberRequest) String() string
func (request DeleteSubscriberRequest) ValidateEnumValue() (bool, error)
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
DeleteSubscriberResponse wrapper for the DeleteSubscriber operation
type DeleteSubscriberResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteSubscriberResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSubscriberResponse) String() string
DeleteUsagePlanRequest wrapper for the DeleteUsagePlan operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteUsagePlan.go.html to see an example of how to use DeleteUsagePlanRequest.
type DeleteUsagePlanRequest struct {
// The ocid of the usage plan.
UsagePlanId *string `mandatory:"true" contributesTo:"path" name:"usagePlanId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request DeleteUsagePlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteUsagePlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteUsagePlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteUsagePlanRequest) String() string
func (request DeleteUsagePlanRequest) ValidateEnumValue() (bool, error)
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
DeleteUsagePlanResponse wrapper for the DeleteUsagePlan operation
type DeleteUsagePlanResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response DeleteUsagePlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteUsagePlanResponse) String() string
Deployment A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).
type Deployment struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
GatewayId *string `mandatory:"true" json:"gatewayId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A path on which to deploy all routes contained in the API
// deployment specification. For more information, see
// Deploying an API on an API Gateway by Creating an API
// Deployment (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).
PathPrefix *string `mandatory:"true" json:"pathPrefix"`
// The endpoint to access this deployment on the gateway.
Endpoint *string `mandatory:"true" json:"endpoint"`
Specification *ApiSpecification `mandatory:"true" json:"specification"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the deployment.
LifecycleState DeploymentLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Deployment) String() string
func (m Deployment) ValidateEnumValue() (bool, error)
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
DeploymentClient a client for Deployment
type DeploymentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDeploymentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DeploymentClient, err error)
NewDeploymentClientWithConfigurationProvider Creates a new default Deployment client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDeploymentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DeploymentClient, err error)
NewDeploymentClientWithOboToken Creates a new default Deployment client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client DeploymentClient) ChangeDeploymentCompartment(ctx context.Context, request ChangeDeploymentCompartmentRequest) (response ChangeDeploymentCompartmentResponse, err error)
ChangeDeploymentCompartment Changes the deployment compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeDeploymentCompartment.go.html to see an example of how to use ChangeDeploymentCompartment API.
func (client *DeploymentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DeploymentClient) CreateDeployment(ctx context.Context, request CreateDeploymentRequest) (response CreateDeploymentResponse, err error)
CreateDeployment Creates a new deployment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateDeployment.go.html to see an example of how to use CreateDeployment API. A default retry strategy applies to this operation CreateDeployment()
func (client DeploymentClient) DeleteDeployment(ctx context.Context, request DeleteDeploymentRequest) (response DeleteDeploymentResponse, err error)
DeleteDeployment Deletes the deployment with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteDeployment.go.html to see an example of how to use DeleteDeployment API.
func (client DeploymentClient) GetDeployment(ctx context.Context, request GetDeploymentRequest) (response GetDeploymentResponse, err error)
GetDeployment Gets a deployment by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetDeployment.go.html to see an example of how to use GetDeployment API. A default retry strategy applies to this operation GetDeployment()
func (client DeploymentClient) ListDeployments(ctx context.Context, request ListDeploymentsRequest) (response ListDeploymentsResponse, err error)
ListDeployments Returns a list of deployments.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListDeployments.go.html to see an example of how to use ListDeployments API. A default retry strategy applies to this operation ListDeployments()
func (client *DeploymentClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DeploymentClient) UpdateDeployment(ctx context.Context, request UpdateDeploymentRequest) (response UpdateDeploymentResponse, err error)
UpdateDeployment Updates the deployment with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateDeployment.go.html to see an example of how to use UpdateDeployment API.
DeploymentCollection Collection of deployment summaries.
type DeploymentCollection struct {
// Deployment summaries.
Items []DeploymentSummary `mandatory:"true" json:"items"`
}
func (m DeploymentCollection) String() string
func (m DeploymentCollection) ValidateEnumValue() (bool, error)
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
DeploymentLifecycleStateEnum Enum with underlying type: string
type DeploymentLifecycleStateEnum string
Set of constants representing the allowable values for DeploymentLifecycleStateEnum
const (
DeploymentLifecycleStateCreating DeploymentLifecycleStateEnum = "CREATING"
DeploymentLifecycleStateActive DeploymentLifecycleStateEnum = "ACTIVE"
DeploymentLifecycleStateUpdating DeploymentLifecycleStateEnum = "UPDATING"
DeploymentLifecycleStateDeleting DeploymentLifecycleStateEnum = "DELETING"
DeploymentLifecycleStateDeleted DeploymentLifecycleStateEnum = "DELETED"
DeploymentLifecycleStateFailed DeploymentLifecycleStateEnum = "FAILED"
)
func GetDeploymentLifecycleStateEnumValues() []DeploymentLifecycleStateEnum
GetDeploymentLifecycleStateEnumValues Enumerates the set of values for DeploymentLifecycleStateEnum
func GetMappingDeploymentLifecycleStateEnum(val string) (DeploymentLifecycleStateEnum, bool)
GetMappingDeploymentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DeploymentSummary A summary of the deployment.
type DeploymentSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
GatewayId *string `mandatory:"true" json:"gatewayId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The path on which all routes contained in the API
// deployment specification are deployed. For more information, see
// Deploying an API on an API Gateway by Creating an API
// Deployment (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).
PathPrefix *string `mandatory:"true" json:"pathPrefix"`
// The endpoint to access this deployment on the gateway.
Endpoint *string `mandatory:"true" json:"endpoint"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the deployment.
LifecycleState DeploymentLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m DeploymentSummary) String() string
func (m DeploymentSummary) ValidateEnumValue() (bool, error)
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
DiscoveryUriSourceUriDetails Discovery Uri information.
type DiscoveryUriSourceUriDetails struct {
// The discovery URI for the auth server.
Uri *string `mandatory:"true" json:"uri"`
}
func (m DiscoveryUriSourceUriDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DiscoveryUriSourceUriDetails) String() string
func (m DiscoveryUriSourceUriDetails) ValidateEnumValue() (bool, error)
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
DynamicAuthenticationPolicy Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.
type DynamicAuthenticationPolicy struct {
SelectionSource SelectionSourcePolicy `mandatory:"true" json:"selectionSource"`
// List of authentication servers to choose from during dynamic authentication.
AuthenticationServers []AuthenticationServerPolicy `mandatory:"true" json:"authenticationServers"`
}
func (m DynamicAuthenticationPolicy) String() string
func (m *DynamicAuthenticationPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DynamicAuthenticationPolicy) ValidateEnumValue() (bool, error)
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
DynamicRoutingBackend Send the request to the backend dynamically selected based on the incoming request's context.
type DynamicRoutingBackend struct {
SelectionSource SelectionSourcePolicy `mandatory:"true" json:"selectionSource"`
// List of backends to chose from for Dynamic Routing.
RoutingBackends []DynamicRoutingTypeRoutingBackend `mandatory:"true" json:"routingBackends"`
}
func (m DynamicRoutingBackend) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DynamicRoutingBackend) String() string
func (m *DynamicRoutingBackend) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DynamicRoutingBackend) ValidateEnumValue() (bool, error)
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
DynamicRoutingTypeRoutingBackend Policy for the details regarding each routing backend under dynamic routing. We specify the value of selectors for which this routing backend must be selected for a request under keys. We specify the configuration details of routing backend under backend.
type DynamicRoutingTypeRoutingBackend struct {
Key DynamicSelectionKey `mandatory:"true" json:"key"`
Backend ApiSpecificationRouteBackend `mandatory:"true" json:"backend"`
}
func (m DynamicRoutingTypeRoutingBackend) String() string
func (m *DynamicRoutingTypeRoutingBackend) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DynamicRoutingTypeRoutingBackend) ValidateEnumValue() (bool, error)
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
DynamicSelectionKey Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests.
type DynamicSelectionKey interface {
// Name assigned to the branch.
GetName() *string
// Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.
GetIsDefault() *bool
}
DynamicSelectionKeyTypeEnum Enum with underlying type: string
type DynamicSelectionKeyTypeEnum string
Set of constants representing the allowable values for DynamicSelectionKeyTypeEnum
const (
DynamicSelectionKeyTypeAnyOf DynamicSelectionKeyTypeEnum = "ANY_OF"
DynamicSelectionKeyTypeWildcard DynamicSelectionKeyTypeEnum = "WILDCARD"
)
func GetDynamicSelectionKeyTypeEnumValues() []DynamicSelectionKeyTypeEnum
GetDynamicSelectionKeyTypeEnumValues Enumerates the set of values for DynamicSelectionKeyTypeEnum
func GetMappingDynamicSelectionKeyTypeEnum(val string) (DynamicSelectionKeyTypeEnum, bool)
GetMappingDynamicSelectionKeyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Entitlement A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.
type Entitlement struct {
// An entitlement name, unique within a usage plan.
Name *string `mandatory:"true" json:"name"`
// A user-friendly description. To provide some insight about the resource.
// Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
RateLimit *RateLimit `mandatory:"false" json:"rateLimit"`
Quota *Quota `mandatory:"false" json:"quota"`
// A collection of targeted deployments that the entitlement will be applied to.
Targets []EntitlementTarget `mandatory:"false" json:"targets"`
}
func (m Entitlement) String() string
func (m Entitlement) ValidateEnumValue() (bool, error)
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
EntitlementSummary A summary of an entitlement included in a usage plan.
type EntitlementSummary struct {
// An entitlement name, unique within a usage plan.
Name *string `mandatory:"true" json:"name"`
// A user-friendly description. To provide some insight about the resource.
// Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
RateLimit *RateLimit `mandatory:"false" json:"rateLimit"`
Quota *Quota `mandatory:"false" json:"quota"`
}
func (m EntitlementSummary) String() string
func (m EntitlementSummary) ValidateEnumValue() (bool, error)
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
EntitlementTarget An entitlement target, describing which deployment the entitlement should be applied to.
type EntitlementTarget struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a deployment
// resource.
DeploymentId *string `mandatory:"true" json:"deploymentId"`
}
func (m EntitlementTarget) String() string
func (m EntitlementTarget) ValidateEnumValue() (bool, error)
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
ExecutionLogPolicy Configures the logging policies for the execution logs of an API Deployment.
type ExecutionLogPolicy struct {
// Enables pushing of execution logs to the legacy OCI Object Storage log archival bucket.
// Oracle recommends using the OCI Logging service to enable, retrieve, and query execution logs
// for an API Deployment. If there is an active log object for the API Deployment and its
// category is set to 'execution' in OCI Logging service, the logs will not be uploaded to the legacy
// OCI Object Storage log archival bucket.
// Please note that the functionality to push to the legacy OCI Object Storage log
// archival bucket has been deprecated and will be removed in the future.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// Specifies the log level used to control logging output of execution logs.
// Enabling logging at a given level also enables logging at all higher levels.
LogLevel ExecutionLogPolicyLogLevelEnum `mandatory:"false" json:"logLevel,omitempty"`
}
func (m ExecutionLogPolicy) String() string
func (m ExecutionLogPolicy) ValidateEnumValue() (bool, error)
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
ExecutionLogPolicyLogLevelEnum Enum with underlying type: string
type ExecutionLogPolicyLogLevelEnum string
Set of constants representing the allowable values for ExecutionLogPolicyLogLevelEnum
const (
ExecutionLogPolicyLogLevelInfo ExecutionLogPolicyLogLevelEnum = "INFO"
ExecutionLogPolicyLogLevelWarn ExecutionLogPolicyLogLevelEnum = "WARN"
ExecutionLogPolicyLogLevelError ExecutionLogPolicyLogLevelEnum = "ERROR"
)
func GetExecutionLogPolicyLogLevelEnumValues() []ExecutionLogPolicyLogLevelEnum
GetExecutionLogPolicyLogLevelEnumValues Enumerates the set of values for ExecutionLogPolicyLogLevelEnum
func GetMappingExecutionLogPolicyLogLevelEnum(val string) (ExecutionLogPolicyLogLevelEnum, bool)
GetMappingExecutionLogPolicyLogLevelEnum performs case Insensitive comparison on enum value and return the desired enum
ExternalRespCache Connection details for an external RESP based cache store for Response Caching.
type ExternalRespCache struct {
// The set of cache store members to connect to. At present only a single server is supported.
Servers []ResponseCacheRespServer `mandatory:"true" json:"servers"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.
AuthenticationSecretId *string `mandatory:"true" json:"authenticationSecretId"`
// The version number of the authentication secret to use.
AuthenticationSecretVersionNumber *int64 `mandatory:"true" json:"authenticationSecretVersionNumber"`
// Defines if the connection should be over SSL.
IsSslEnabled *bool `mandatory:"false" json:"isSslEnabled"`
// Defines whether or not to uphold SSL verification.
IsSslVerifyDisabled *bool `mandatory:"false" json:"isSslVerifyDisabled"`
// Defines the timeout for establishing a connection with the Response Cache.
ConnectTimeoutInMs *int `mandatory:"false" json:"connectTimeoutInMs"`
// Defines the timeout for reading data from the Response Cache.
ReadTimeoutInMs *int `mandatory:"false" json:"readTimeoutInMs"`
// Defines the timeout for transmitting data to the Response Cache.
SendTimeoutInMs *int `mandatory:"false" json:"sendTimeoutInMs"`
}
func (m ExternalRespCache) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ExternalRespCache) String() string
func (m ExternalRespCache) ValidateEnumValue() (bool, error)
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
FilterHeaderPolicy Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
type FilterHeaderPolicy struct {
// BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW
// permits only the headers in the list and removes all others, so it acts as an inclusion list.
Type FilterHeaderPolicyTypeEnum `mandatory:"true" json:"type"`
// The list of headers.
Items []FilterHeaderPolicyItem `mandatory:"true" json:"items"`
}
func (m FilterHeaderPolicy) String() string
func (m FilterHeaderPolicy) ValidateEnumValue() (bool, error)
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
FilterHeaderPolicyItem A header to drop (with BLOCK) or pass through (with ALLOW).
type FilterHeaderPolicyItem struct {
// The case-insensitive name of the header. This name must be unique across transformation policies.
Name *string `mandatory:"true" json:"name"`
}
func (m FilterHeaderPolicyItem) String() string
func (m FilterHeaderPolicyItem) ValidateEnumValue() (bool, error)
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
FilterHeaderPolicyTypeEnum Enum with underlying type: string
type FilterHeaderPolicyTypeEnum string
Set of constants representing the allowable values for FilterHeaderPolicyTypeEnum
const (
FilterHeaderPolicyTypeAllow FilterHeaderPolicyTypeEnum = "ALLOW"
FilterHeaderPolicyTypeBlock FilterHeaderPolicyTypeEnum = "BLOCK"
)
func GetFilterHeaderPolicyTypeEnumValues() []FilterHeaderPolicyTypeEnum
GetFilterHeaderPolicyTypeEnumValues Enumerates the set of values for FilterHeaderPolicyTypeEnum
func GetMappingFilterHeaderPolicyTypeEnum(val string) (FilterHeaderPolicyTypeEnum, bool)
GetMappingFilterHeaderPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FilterQueryParameterPolicy Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
type FilterQueryParameterPolicy struct {
// BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list. ALLOW
// permits only the parameters in the list and removes all others, so it acts as an inclusion list.
Type FilterQueryParameterPolicyTypeEnum `mandatory:"true" json:"type"`
// The list of query parameters.
Items []FilterQueryParameterPolicyItem `mandatory:"true" json:"items"`
}
func (m FilterQueryParameterPolicy) String() string
func (m FilterQueryParameterPolicy) ValidateEnumValue() (bool, error)
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
FilterQueryParameterPolicyItem A query parameter to drop (with BLOCK) or pass through (with ALLOW).
type FilterQueryParameterPolicyItem struct {
// The case-sensitive name of the query parameter.
Name *string `mandatory:"true" json:"name"`
}
func (m FilterQueryParameterPolicyItem) String() string
func (m FilterQueryParameterPolicyItem) ValidateEnumValue() (bool, error)
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
FilterQueryParameterPolicyTypeEnum Enum with underlying type: string
type FilterQueryParameterPolicyTypeEnum string
Set of constants representing the allowable values for FilterQueryParameterPolicyTypeEnum
const (
FilterQueryParameterPolicyTypeAllow FilterQueryParameterPolicyTypeEnum = "ALLOW"
FilterQueryParameterPolicyTypeBlock FilterQueryParameterPolicyTypeEnum = "BLOCK"
)
func GetFilterQueryParameterPolicyTypeEnumValues() []FilterQueryParameterPolicyTypeEnum
GetFilterQueryParameterPolicyTypeEnumValues Enumerates the set of values for FilterQueryParameterPolicyTypeEnum
func GetMappingFilterQueryParameterPolicyTypeEnum(val string) (FilterQueryParameterPolicyTypeEnum, bool)
GetMappingFilterQueryParameterPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FixedTtlResponseCacheStorePolicy How a response from a backend is cached in the Response Cache.
type FixedTtlResponseCacheStorePolicy struct {
// Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
TimeToLiveInSeconds *int `mandatory:"true" json:"timeToLiveInSeconds"`
}
func (m FixedTtlResponseCacheStorePolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FixedTtlResponseCacheStorePolicy) String() string
func (m FixedTtlResponseCacheStorePolicy) ValidateEnumValue() (bool, error)
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
Gateway A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see API Gateway Concepts (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).
type Gateway struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be
// accessible on a private IP address on the subnet.
// Example: `PUBLIC` or `PRIVATE`
EndpointType GatewayEndpointTypeEnum `mandatory:"true" json:"endpointType"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet in which
// related resources are created.
SubnetId *string `mandatory:"false" json:"subnetId"`
// An array of Network Security Groups OCIDs associated with this API Gateway.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the gateway.
LifecycleState GatewayLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The hostname for APIs deployed on the gateway.
Hostname *string `mandatory:"false" json:"hostname"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
CertificateId *string `mandatory:"false" json:"certificateId"`
// An array of IP addresses associated with the gateway.
IpAddresses []IpAddress `mandatory:"false" json:"ipAddresses"`
ResponseCacheDetails ResponseCacheDetails `mandatory:"false" json:"responseCacheDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// An array of CA bundles that should be used on the Gateway for TLS validation.
CaBundles []CaBundle `mandatory:"false" json:"caBundles"`
}
func (m Gateway) String() string
func (m *Gateway) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Gateway) ValidateEnumValue() (bool, error)
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
GatewayClient a client for Gateway
type GatewayClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGatewayClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GatewayClient, err error)
NewGatewayClientWithConfigurationProvider Creates a new default Gateway client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGatewayClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GatewayClient, err error)
NewGatewayClientWithOboToken Creates a new default Gateway client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client GatewayClient) ChangeGatewayCompartment(ctx context.Context, request ChangeGatewayCompartmentRequest) (response ChangeGatewayCompartmentResponse, err error)
ChangeGatewayCompartment Changes the gateway compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeGatewayCompartment.go.html to see an example of how to use ChangeGatewayCompartment API.
func (client *GatewayClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GatewayClient) CreateGateway(ctx context.Context, request CreateGatewayRequest) (response CreateGatewayResponse, err error)
CreateGateway Creates a new gateway.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateGateway.go.html to see an example of how to use CreateGateway API. A default retry strategy applies to this operation CreateGateway()
func (client GatewayClient) DeleteGateway(ctx context.Context, request DeleteGatewayRequest) (response DeleteGatewayResponse, err error)
DeleteGateway Deletes the gateway with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteGateway.go.html to see an example of how to use DeleteGateway API.
func (client GatewayClient) GetGateway(ctx context.Context, request GetGatewayRequest) (response GetGatewayResponse, err error)
GetGateway Gets a gateway by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetGateway.go.html to see an example of how to use GetGateway API. A default retry strategy applies to this operation GetGateway()
func (client GatewayClient) ListGateways(ctx context.Context, request ListGatewaysRequest) (response ListGatewaysResponse, err error)
ListGateways Returns a list of gateways.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListGateways.go.html to see an example of how to use ListGateways API. A default retry strategy applies to this operation ListGateways()
func (client *GatewayClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client GatewayClient) UpdateGateway(ctx context.Context, request UpdateGatewayRequest) (response UpdateGatewayResponse, err error)
UpdateGateway Updates the gateway with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateGateway.go.html to see an example of how to use UpdateGateway API.
GatewayCollection Collection of gateway summaries.
type GatewayCollection struct {
// Gateway summaries.
Items []GatewaySummary `mandatory:"true" json:"items"`
}
func (m GatewayCollection) String() string
func (m GatewayCollection) ValidateEnumValue() (bool, error)
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
GatewayEndpointTypeEnum Enum with underlying type: string
type GatewayEndpointTypeEnum string
Set of constants representing the allowable values for GatewayEndpointTypeEnum
const (
GatewayEndpointTypePublic GatewayEndpointTypeEnum = "PUBLIC"
GatewayEndpointTypePrivate GatewayEndpointTypeEnum = "PRIVATE"
)
func GetGatewayEndpointTypeEnumValues() []GatewayEndpointTypeEnum
GetGatewayEndpointTypeEnumValues Enumerates the set of values for GatewayEndpointTypeEnum
func GetMappingGatewayEndpointTypeEnum(val string) (GatewayEndpointTypeEnum, bool)
GetMappingGatewayEndpointTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GatewayLifecycleStateEnum Enum with underlying type: string
type GatewayLifecycleStateEnum string
Set of constants representing the allowable values for GatewayLifecycleStateEnum
const (
GatewayLifecycleStateCreating GatewayLifecycleStateEnum = "CREATING"
GatewayLifecycleStateActive GatewayLifecycleStateEnum = "ACTIVE"
GatewayLifecycleStateUpdating GatewayLifecycleStateEnum = "UPDATING"
GatewayLifecycleStateDeleting GatewayLifecycleStateEnum = "DELETING"
GatewayLifecycleStateDeleted GatewayLifecycleStateEnum = "DELETED"
GatewayLifecycleStateFailed GatewayLifecycleStateEnum = "FAILED"
)
func GetGatewayLifecycleStateEnumValues() []GatewayLifecycleStateEnum
GetGatewayLifecycleStateEnumValues Enumerates the set of values for GatewayLifecycleStateEnum
func GetMappingGatewayLifecycleStateEnum(val string) (GatewayLifecycleStateEnum, bool)
GetMappingGatewayLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
GatewaySummary A summary of the gateway.
type GatewaySummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be
// accessible on a private IP address on the subnet.
// Example: `PUBLIC` or `PRIVATE`
EndpointType GatewayEndpointTypeEnum `mandatory:"true" json:"endpointType"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet in which
// related resources are created.
SubnetId *string `mandatory:"false" json:"subnetId"`
// An array of Network Security Groups OCIDs associated with this API Gateway.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the gateway.
LifecycleState GatewayLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The hostname for the APIs deployed on the gateway.
Hostname *string `mandatory:"false" json:"hostname"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
CertificateId *string `mandatory:"false" json:"certificateId"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m GatewaySummary) String() string
func (m GatewaySummary) ValidateEnumValue() (bool, error)
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
GetApiContentRequest wrapper for the GetApiContent operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetApiContent.go.html to see an example of how to use GetApiContentRequest.
type GetApiContentRequest struct {
// The ocid of the API.
ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`
// The client request id for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The Range HTTP request header indicates the part of a document that the
// server should return. RFC 7233 (https://tools.ietf.org/html/rfc7233#section-3.1).
// Note that only a single range of bytes is supported.
Range *string `mandatory:"false" contributesTo:"header" name:"range"`
// 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 GetApiContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApiContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApiContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApiContentRequest) String() string
func (request GetApiContentRequest) ValidateEnumValue() (bool, error)
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
GetApiContentResponse wrapper for the GetApiContent operation
type GetApiContentResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
// Base64 encoded Sha256 of the body.
XContentSha256 *string `presentIn:"header" name:"x-content-sha256"`
}
func (response GetApiContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApiContentResponse) String() string
GetApiDeploymentSpecificationRequest wrapper for the GetApiDeploymentSpecification operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetApiDeploymentSpecification.go.html to see an example of how to use GetApiDeploymentSpecificationRequest.
type GetApiDeploymentSpecificationRequest struct {
// The ocid of the API.
ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`
// The client request id for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 GetApiDeploymentSpecificationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApiDeploymentSpecificationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApiDeploymentSpecificationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApiDeploymentSpecificationRequest) String() string
func (request GetApiDeploymentSpecificationRequest) ValidateEnumValue() (bool, error)
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
GetApiDeploymentSpecificationResponse wrapper for the GetApiDeploymentSpecification operation
type GetApiDeploymentSpecificationResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApiSpecification instance
ApiSpecification `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetApiDeploymentSpecificationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApiDeploymentSpecificationResponse) String() string
GetApiRequest wrapper for the GetApi operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetApi.go.html to see an example of how to use GetApiRequest.
type GetApiRequest struct {
// The ocid of the API.
ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`
// The client request id for tracing.
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
}
func (request GetApiRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApiRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApiRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApiRequest) String() string
func (request GetApiRequest) ValidateEnumValue() (bool, error)
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
GetApiResponse wrapper for the GetApi operation
type GetApiResponse struct {
// The underlying http response
RawResponse *http.Response
// The Api instance
Api `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetApiResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApiResponse) String() string
GetApiValidationsRequest wrapper for the GetApiValidations operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetApiValidations.go.html to see an example of how to use GetApiValidationsRequest.
type GetApiValidationsRequest struct {
// The ocid of the API.
ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`
// The client request id for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 GetApiValidationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApiValidationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApiValidationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApiValidationsRequest) String() string
func (request GetApiValidationsRequest) ValidateEnumValue() (bool, error)
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
GetApiValidationsResponse wrapper for the GetApiValidations operation
type GetApiValidationsResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApiValidations instance
ApiValidations `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetApiValidationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApiValidationsResponse) String() string
GetCertificateRequest wrapper for the GetCertificate operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetCertificate.go.html to see an example of how to use GetCertificateRequest.
type GetCertificateRequest struct {
// The ocid of the certificate.
CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`
// The client request id for tracing.
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
}
func (request GetCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCertificateRequest) String() string
func (request GetCertificateRequest) ValidateEnumValue() (bool, error)
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
GetCertificateResponse wrapper for the GetCertificate operation
type GetCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The Certificate instance
Certificate `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCertificateResponse) String() string
GetDeploymentRequest wrapper for the GetDeployment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetDeployment.go.html to see an example of how to use GetDeploymentRequest.
type GetDeploymentRequest struct {
// The ocid of the deployment.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// The client request id for tracing.
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
}
func (request GetDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDeploymentRequest) String() string
func (request GetDeploymentRequest) ValidateEnumValue() (bool, error)
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
GetDeploymentResponse wrapper for the GetDeployment operation
type GetDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The Deployment instance
Deployment `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDeploymentResponse) String() string
GetGatewayRequest wrapper for the GetGateway operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetGateway.go.html to see an example of how to use GetGatewayRequest.
type GetGatewayRequest struct {
// The ocid of the gateway.
GatewayId *string `mandatory:"true" contributesTo:"path" name:"gatewayId"`
// The client request id for tracing.
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
}
func (request GetGatewayRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGatewayRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGatewayRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGatewayRequest) String() string
func (request GetGatewayRequest) ValidateEnumValue() (bool, error)
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
GetGatewayResponse wrapper for the GetGateway operation
type GetGatewayResponse struct {
// The underlying http response
RawResponse *http.Response
// The Gateway instance
Gateway `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetGatewayResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGatewayResponse) String() string
GetSdkRequest wrapper for the GetSdk operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetSdk.go.html to see an example of how to use GetSdkRequest.
type GetSdkRequest struct {
// The ocid of the SDK.
SdkId *string `mandatory:"true" contributesTo:"path" name:"sdkId"`
// The client request id for tracing.
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
}
func (request GetSdkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSdkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSdkRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSdkRequest) String() string
func (request GetSdkRequest) ValidateEnumValue() (bool, error)
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
GetSdkResponse wrapper for the GetSdk operation
type GetSdkResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sdk instance
Sdk `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetSdkResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSdkResponse) String() string
GetSubscriberRequest wrapper for the GetSubscriber operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetSubscriber.go.html to see an example of how to use GetSubscriberRequest.
type GetSubscriberRequest struct {
// The ocid of the subscriber.
SubscriberId *string `mandatory:"true" contributesTo:"path" name:"subscriberId"`
// The client request id for tracing.
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
}
func (request GetSubscriberRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSubscriberRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSubscriberRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSubscriberRequest) String() string
func (request GetSubscriberRequest) ValidateEnumValue() (bool, error)
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
GetSubscriberResponse wrapper for the GetSubscriber operation
type GetSubscriberResponse struct {
// The underlying http response
RawResponse *http.Response
// The Subscriber instance
Subscriber `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetSubscriberResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSubscriberResponse) String() string
GetUsagePlanRequest wrapper for the GetUsagePlan operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetUsagePlan.go.html to see an example of how to use GetUsagePlanRequest.
type GetUsagePlanRequest struct {
// The ocid of the usage plan.
UsagePlanId *string `mandatory:"true" contributesTo:"path" name:"usagePlanId"`
// The client request id for tracing.
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
}
func (request GetUsagePlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetUsagePlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetUsagePlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetUsagePlanRequest) String() string
func (request GetUsagePlanRequest) ValidateEnumValue() (bool, error)
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
GetUsagePlanResponse wrapper for the GetUsagePlan operation
type GetUsagePlanResponse struct {
// The underlying http response
RawResponse *http.Response
// The UsagePlan instance
UsagePlan `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
}
func (response GetUsagePlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetUsagePlanResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ocid of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request id for tracing.
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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
// A decimal number representing the number of seconds the client
// should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HeaderFieldSpecification Header in key/value pair.
type HeaderFieldSpecification struct {
// Name of the header.
Name *string `mandatory:"false" json:"name"`
// Value of the header.
Value *string `mandatory:"false" json:"value"`
}
func (m HeaderFieldSpecification) String() string
func (m HeaderFieldSpecification) ValidateEnumValue() (bool, error)
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
HeaderTransformationPolicy A set of transformations to apply to HTTP headers that pass through the gateway.
type HeaderTransformationPolicy struct {
SetHeaders *SetHeaderPolicy `mandatory:"false" json:"setHeaders"`
RenameHeaders *RenameHeaderPolicy `mandatory:"false" json:"renameHeaders"`
FilterHeaders *FilterHeaderPolicy `mandatory:"false" json:"filterHeaders"`
}
func (m HeaderTransformationPolicy) String() string
func (m HeaderTransformationPolicy) ValidateEnumValue() (bool, error)
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
HeaderValidationItem Header validation properties.
type HeaderValidationItem struct {
// Parameter name.
Name *string `mandatory:"true" json:"name"`
// Determines if the header is required in the request.
Required *bool `mandatory:"false" json:"required"`
}
func (m HeaderValidationItem) String() string
func (m HeaderValidationItem) ValidateEnumValue() (bool, error)
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
HeaderValidationRequestPolicy Validate the HTTP headers on the incoming API requests on a specific route.
type HeaderValidationRequestPolicy struct {
// Validation behavior mode.
// In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response
// and not sent to the backend.
// In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request
// will follow the normal path.
// `DISABLED` type turns the validation off.
ValidationMode HeaderValidationRequestPolicyValidationModeEnum `mandatory:"false" json:"validationMode,omitempty"`
Headers []HeaderValidationItem `mandatory:"false" json:"headers"`
}
func (m HeaderValidationRequestPolicy) String() string
func (m HeaderValidationRequestPolicy) ValidateEnumValue() (bool, error)
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
HeaderValidationRequestPolicyValidationModeEnum Enum with underlying type: string
type HeaderValidationRequestPolicyValidationModeEnum string
Set of constants representing the allowable values for HeaderValidationRequestPolicyValidationModeEnum
const (
HeaderValidationRequestPolicyValidationModeEnforcing HeaderValidationRequestPolicyValidationModeEnum = "ENFORCING"
HeaderValidationRequestPolicyValidationModePermissive HeaderValidationRequestPolicyValidationModeEnum = "PERMISSIVE"
HeaderValidationRequestPolicyValidationModeDisabled HeaderValidationRequestPolicyValidationModeEnum = "DISABLED"
)
func GetHeaderValidationRequestPolicyValidationModeEnumValues() []HeaderValidationRequestPolicyValidationModeEnum
GetHeaderValidationRequestPolicyValidationModeEnumValues Enumerates the set of values for HeaderValidationRequestPolicyValidationModeEnum
func GetMappingHeaderValidationRequestPolicyValidationModeEnum(val string) (HeaderValidationRequestPolicyValidationModeEnum, bool)
GetMappingHeaderValidationRequestPolicyValidationModeEnum performs case Insensitive comparison on enum value and return the desired enum
HttpBackend Send the request to an HTTP backend.
type HttpBackend struct {
Url *string `mandatory:"true" json:"url"`
// Defines a timeout for establishing a connection with a proxied server.
ConnectTimeoutInSeconds *float32 `mandatory:"false" json:"connectTimeoutInSeconds"`
// Defines a timeout for reading a response from the proxied server.
ReadTimeoutInSeconds *float32 `mandatory:"false" json:"readTimeoutInSeconds"`
// Defines a timeout for transmitting a request to the proxied server.
SendTimeoutInSeconds *float32 `mandatory:"false" json:"sendTimeoutInSeconds"`
// Defines whether or not to uphold SSL verification.
IsSslVerifyDisabled *bool `mandatory:"false" json:"isSslVerifyDisabled"`
}
func (m HttpBackend) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m HttpBackend) String() string
func (m HttpBackend) ValidateEnumValue() (bool, error)
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
IpAddress IP address associated with the gateway.
type IpAddress struct {
// An IP address.
IpAddress *string `mandatory:"true" json:"ipAddress"`
}
func (m IpAddress) String() string
func (m IpAddress) ValidateEnumValue() (bool, error)
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
JsonWebKey A JSON Web Key that represents the public key used for verifying the JWT signature.
type JsonWebKey struct {
// A unique key ID. This key will be used to verify the signature of a
// JWT with matching "kid".
Kid *string `mandatory:"true" json:"kid"`
// The algorithm intended for use with this key.
Alg *string `mandatory:"true" json:"alg"`
// The base64 url encoded modulus of the RSA public key represented
// by this key.
N *string `mandatory:"true" json:"n"`
// The base64 url encoded exponent of the RSA public key represented
// by this key.
E *string `mandatory:"true" json:"e"`
// The key type.
Kty JsonWebKeyKtyEnum `mandatory:"true" json:"kty"`
// The intended use of the public key.
Use JsonWebKeyUseEnum `mandatory:"false" json:"use,omitempty"`
// The operations for which this key is to be used.
KeyOps []JsonWebKeyKeyOpsEnum `mandatory:"false" json:"key_ops,omitempty"`
}
func (m JsonWebKey) GetKid() *string
GetKid returns Kid
func (m JsonWebKey) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m JsonWebKey) String() string
func (m JsonWebKey) ValidateEnumValue() (bool, error)
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
JsonWebKeyKeyOpsEnum Enum with underlying type: string
type JsonWebKeyKeyOpsEnum string
Set of constants representing the allowable values for JsonWebKeyKeyOpsEnum
const (
JsonWebKeyKeyOpsVerify JsonWebKeyKeyOpsEnum = "verify"
)
func GetJsonWebKeyKeyOpsEnumValues() []JsonWebKeyKeyOpsEnum
GetJsonWebKeyKeyOpsEnumValues Enumerates the set of values for JsonWebKeyKeyOpsEnum
func GetMappingJsonWebKeyKeyOpsEnum(val string) (JsonWebKeyKeyOpsEnum, bool)
GetMappingJsonWebKeyKeyOpsEnum performs case Insensitive comparison on enum value and return the desired enum
JsonWebKeyKtyEnum Enum with underlying type: string
type JsonWebKeyKtyEnum string
Set of constants representing the allowable values for JsonWebKeyKtyEnum
const (
JsonWebKeyKtyRsa JsonWebKeyKtyEnum = "RSA"
)
func GetJsonWebKeyKtyEnumValues() []JsonWebKeyKtyEnum
GetJsonWebKeyKtyEnumValues Enumerates the set of values for JsonWebKeyKtyEnum
func GetMappingJsonWebKeyKtyEnum(val string) (JsonWebKeyKtyEnum, bool)
GetMappingJsonWebKeyKtyEnum performs case Insensitive comparison on enum value and return the desired enum
JsonWebKeyUseEnum Enum with underlying type: string
type JsonWebKeyUseEnum string
Set of constants representing the allowable values for JsonWebKeyUseEnum
const (
JsonWebKeyUseSig JsonWebKeyUseEnum = "sig"
)
func GetJsonWebKeyUseEnumValues() []JsonWebKeyUseEnum
GetJsonWebKeyUseEnumValues Enumerates the set of values for JsonWebKeyUseEnum
func GetMappingJsonWebKeyUseEnum(val string) (JsonWebKeyUseEnum, bool)
GetMappingJsonWebKeyUseEnum performs case Insensitive comparison on enum value and return the desired enum
JsonWebTokenClaim An individual JWT claim.
type JsonWebTokenClaim struct {
// Name of the claim.
Key *string `mandatory:"true" json:"key"`
// The list of acceptable values for a given claim.
// If this value is "null" or empty and "isRequired" set to "true", then
// the presence of this claim in the JWT is validated.
Values []string `mandatory:"false" json:"values"`
// Whether the claim is required to be present in the JWT or not. If set
// to "false", the claim values will be matched only if the claim is
// present in the JWT.
IsRequired *bool `mandatory:"false" json:"isRequired"`
}
func (m JsonWebTokenClaim) String() string
func (m JsonWebTokenClaim) ValidateEnumValue() (bool, error)
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
JwtAuthenticationPolicy Validate a JWT token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.
type JwtAuthenticationPolicy struct {
// A list of parties that could have issued the token.
Issuers []string `mandatory:"true" json:"issuers"`
// The list of intended recipients for the token.
Audiences []string `mandatory:"true" json:"audiences"`
PublicKeys PublicKeySet `mandatory:"true" json:"publicKeys"`
// Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS
// route authorization.
IsAnonymousAccessAllowed *bool `mandatory:"false" json:"isAnonymousAccessAllowed"`
// The name of the header containing the authentication token.
TokenHeader *string `mandatory:"false" json:"tokenHeader"`
// The name of the query parameter containing the authentication token.
TokenQueryParam *string `mandatory:"false" json:"tokenQueryParam"`
// The authentication scheme that is to be used when authenticating
// the token. This must to be provided if "tokenHeader" is specified.
TokenAuthScheme *string `mandatory:"false" json:"tokenAuthScheme"`
// The maximum expected time difference between the system clocks
// of the token issuer and the API Gateway.
MaxClockSkewInSeconds *float32 `mandatory:"false" json:"maxClockSkewInSeconds"`
// A list of claims which should be validated to consider the token valid.
VerifyClaims []JsonWebTokenClaim `mandatory:"false" json:"verifyClaims"`
}
func (m JwtAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool
GetIsAnonymousAccessAllowed returns IsAnonymousAccessAllowed
func (m JwtAuthenticationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m JwtAuthenticationPolicy) String() string
func (m *JwtAuthenticationPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m JwtAuthenticationPolicy) ValidateEnumValue() (bool, error)
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
ListApisRequest wrapper for the ListApis operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListApis.go.html to see an example of how to use ListApisRequest.
type ListApisRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state.
// Example: `ACTIVE`
LifecycleState ApiSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListApisSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListApisSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request id for tracing.
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
}
func (request ListApisRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApisRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApisRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApisRequest) String() string
func (request ListApisRequest) ValidateEnumValue() (bool, error)
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
ListApisResponse wrapper for the ListApis operation
type ListApisResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ApiCollection instances
ApiCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListApisResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApisResponse) String() string
ListApisSortByEnum Enum with underlying type: string
type ListApisSortByEnum string
Set of constants representing the allowable values for ListApisSortByEnum
const (
ListApisSortByTimecreated ListApisSortByEnum = "timeCreated"
ListApisSortByDisplayname ListApisSortByEnum = "displayName"
)
func GetListApisSortByEnumValues() []ListApisSortByEnum
GetListApisSortByEnumValues Enumerates the set of values for ListApisSortByEnum
func GetMappingListApisSortByEnum(val string) (ListApisSortByEnum, bool)
GetMappingListApisSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListApisSortOrderEnum Enum with underlying type: string
type ListApisSortOrderEnum string
Set of constants representing the allowable values for ListApisSortOrderEnum
const (
ListApisSortOrderAsc ListApisSortOrderEnum = "ASC"
ListApisSortOrderDesc ListApisSortOrderEnum = "DESC"
)
func GetListApisSortOrderEnumValues() []ListApisSortOrderEnum
GetListApisSortOrderEnumValues Enumerates the set of values for ListApisSortOrderEnum
func GetMappingListApisSortOrderEnum(val string) (ListApisSortOrderEnum, bool)
GetMappingListApisSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCertificatesRequest wrapper for the ListCertificates operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListCertificates.go.html to see an example of how to use ListCertificatesRequest.
type ListCertificatesRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state.
// Example: `ACTIVE` or `DELETED`
LifecycleState CertificateLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListCertificatesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListCertificatesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request id for tracing.
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
}
func (request ListCertificatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCertificatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCertificatesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCertificatesRequest) String() string
func (request ListCertificatesRequest) ValidateEnumValue() (bool, error)
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
ListCertificatesResponse wrapper for the ListCertificates operation
type ListCertificatesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of CertificateCollection instances
CertificateCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListCertificatesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCertificatesResponse) String() string
ListCertificatesSortByEnum Enum with underlying type: string
type ListCertificatesSortByEnum string
Set of constants representing the allowable values for ListCertificatesSortByEnum
const (
ListCertificatesSortByTimecreated ListCertificatesSortByEnum = "timeCreated"
ListCertificatesSortByDisplayname ListCertificatesSortByEnum = "displayName"
)
func GetListCertificatesSortByEnumValues() []ListCertificatesSortByEnum
GetListCertificatesSortByEnumValues Enumerates the set of values for ListCertificatesSortByEnum
func GetMappingListCertificatesSortByEnum(val string) (ListCertificatesSortByEnum, bool)
GetMappingListCertificatesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCertificatesSortOrderEnum Enum with underlying type: string
type ListCertificatesSortOrderEnum string
Set of constants representing the allowable values for ListCertificatesSortOrderEnum
const (
ListCertificatesSortOrderAsc ListCertificatesSortOrderEnum = "ASC"
ListCertificatesSortOrderDesc ListCertificatesSortOrderEnum = "DESC"
)
func GetListCertificatesSortOrderEnumValues() []ListCertificatesSortOrderEnum
GetListCertificatesSortOrderEnumValues Enumerates the set of values for ListCertificatesSortOrderEnum
func GetMappingListCertificatesSortOrderEnum(val string) (ListCertificatesSortOrderEnum, bool)
GetMappingListCertificatesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentsRequest wrapper for the ListDeployments operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListDeployments.go.html to see an example of how to use ListDeploymentsRequest.
type ListDeploymentsRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Filter deployments by the gateway ocid.
GatewayId *string `mandatory:"false" contributesTo:"query" name:"gatewayId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state.
// Example: `SUCCEEDED`
LifecycleState DeploymentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListDeploymentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListDeploymentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request id for tracing.
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
}
func (request ListDeploymentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDeploymentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDeploymentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDeploymentsRequest) String() string
func (request ListDeploymentsRequest) ValidateEnumValue() (bool, error)
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
ListDeploymentsResponse wrapper for the ListDeployments operation
type ListDeploymentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DeploymentCollection instances
DeploymentCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListDeploymentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDeploymentsResponse) String() string
ListDeploymentsSortByEnum Enum with underlying type: string
type ListDeploymentsSortByEnum string
Set of constants representing the allowable values for ListDeploymentsSortByEnum
const (
ListDeploymentsSortByTimecreated ListDeploymentsSortByEnum = "timeCreated"
ListDeploymentsSortByDisplayname ListDeploymentsSortByEnum = "displayName"
)
func GetListDeploymentsSortByEnumValues() []ListDeploymentsSortByEnum
GetListDeploymentsSortByEnumValues Enumerates the set of values for ListDeploymentsSortByEnum
func GetMappingListDeploymentsSortByEnum(val string) (ListDeploymentsSortByEnum, bool)
GetMappingListDeploymentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDeploymentsSortOrderEnum Enum with underlying type: string
type ListDeploymentsSortOrderEnum string
Set of constants representing the allowable values for ListDeploymentsSortOrderEnum
const (
ListDeploymentsSortOrderAsc ListDeploymentsSortOrderEnum = "ASC"
ListDeploymentsSortOrderDesc ListDeploymentsSortOrderEnum = "DESC"
)
func GetListDeploymentsSortOrderEnumValues() []ListDeploymentsSortOrderEnum
GetListDeploymentsSortOrderEnumValues Enumerates the set of values for ListDeploymentsSortOrderEnum
func GetMappingListDeploymentsSortOrderEnum(val string) (ListDeploymentsSortOrderEnum, bool)
GetMappingListDeploymentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGatewaysRequest wrapper for the ListGateways operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListGateways.go.html to see an example of how to use ListGatewaysRequest.
type ListGatewaysRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Filter gateways by the certificate ocid.
CertificateId *string `mandatory:"false" contributesTo:"query" name:"certificateId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state.
// Example: `SUCCEEDED`
LifecycleState GatewayLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListGatewaysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListGatewaysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request id for tracing.
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
}
func (request ListGatewaysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGatewaysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGatewaysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGatewaysRequest) String() string
func (request ListGatewaysRequest) ValidateEnumValue() (bool, error)
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
ListGatewaysResponse wrapper for the ListGateways operation
type ListGatewaysResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GatewayCollection instances
GatewayCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListGatewaysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGatewaysResponse) String() string
ListGatewaysSortByEnum Enum with underlying type: string
type ListGatewaysSortByEnum string
Set of constants representing the allowable values for ListGatewaysSortByEnum
const (
ListGatewaysSortByTimecreated ListGatewaysSortByEnum = "timeCreated"
ListGatewaysSortByDisplayname ListGatewaysSortByEnum = "displayName"
)
func GetListGatewaysSortByEnumValues() []ListGatewaysSortByEnum
GetListGatewaysSortByEnumValues Enumerates the set of values for ListGatewaysSortByEnum
func GetMappingListGatewaysSortByEnum(val string) (ListGatewaysSortByEnum, bool)
GetMappingListGatewaysSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGatewaysSortOrderEnum Enum with underlying type: string
type ListGatewaysSortOrderEnum string
Set of constants representing the allowable values for ListGatewaysSortOrderEnum
const (
ListGatewaysSortOrderAsc ListGatewaysSortOrderEnum = "ASC"
ListGatewaysSortOrderDesc ListGatewaysSortOrderEnum = "DESC"
)
func GetListGatewaysSortOrderEnumValues() []ListGatewaysSortOrderEnum
GetListGatewaysSortOrderEnumValues Enumerates the set of values for ListGatewaysSortOrderEnum
func GetMappingListGatewaysSortOrderEnum(val string) (ListGatewaysSortOrderEnum, bool)
GetMappingListGatewaysSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSdkLanguageTypesRequest wrapper for the ListSdkLanguageTypes operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListSdkLanguageTypes.go.html to see an example of how to use ListSdkLanguageTypesRequest.
type ListSdkLanguageTypesRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListSdkLanguageTypesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListSdkLanguageTypesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request id for tracing.
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
}
func (request ListSdkLanguageTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSdkLanguageTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSdkLanguageTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSdkLanguageTypesRequest) String() string
func (request ListSdkLanguageTypesRequest) ValidateEnumValue() (bool, error)
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
ListSdkLanguageTypesResponse wrapper for the ListSdkLanguageTypes operation
type ListSdkLanguageTypesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SdkLanguageTypeCollection instances
SdkLanguageTypeCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListSdkLanguageTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSdkLanguageTypesResponse) String() string
ListSdkLanguageTypesSortByEnum Enum with underlying type: string
type ListSdkLanguageTypesSortByEnum string
Set of constants representing the allowable values for ListSdkLanguageTypesSortByEnum
const (
ListSdkLanguageTypesSortByTimecreated ListSdkLanguageTypesSortByEnum = "timeCreated"
ListSdkLanguageTypesSortByDisplayname ListSdkLanguageTypesSortByEnum = "displayName"
)
func GetListSdkLanguageTypesSortByEnumValues() []ListSdkLanguageTypesSortByEnum
GetListSdkLanguageTypesSortByEnumValues Enumerates the set of values for ListSdkLanguageTypesSortByEnum
func GetMappingListSdkLanguageTypesSortByEnum(val string) (ListSdkLanguageTypesSortByEnum, bool)
GetMappingListSdkLanguageTypesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSdkLanguageTypesSortOrderEnum Enum with underlying type: string
type ListSdkLanguageTypesSortOrderEnum string
Set of constants representing the allowable values for ListSdkLanguageTypesSortOrderEnum
const (
ListSdkLanguageTypesSortOrderAsc ListSdkLanguageTypesSortOrderEnum = "ASC"
ListSdkLanguageTypesSortOrderDesc ListSdkLanguageTypesSortOrderEnum = "DESC"
)
func GetListSdkLanguageTypesSortOrderEnumValues() []ListSdkLanguageTypesSortOrderEnum
GetListSdkLanguageTypesSortOrderEnumValues Enumerates the set of values for ListSdkLanguageTypesSortOrderEnum
func GetMappingListSdkLanguageTypesSortOrderEnum(val string) (ListSdkLanguageTypesSortOrderEnum, bool)
GetMappingListSdkLanguageTypesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSdksRequest wrapper for the ListSdks operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListSdks.go.html to see an example of how to use ListSdksRequest.
type ListSdksRequest struct {
// The ocid of the SDK.
SdkId *string `mandatory:"false" contributesTo:"query" name:"sdkId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state.
// Example: `ACTIVE` or `DELETED`
LifecycleState SdkLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListSdksSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListSdksSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The ocid of the API.
ApiId *string `mandatory:"false" contributesTo:"query" name:"apiId"`
// The client request id for tracing.
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
}
func (request ListSdksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSdksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSdksRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSdksRequest) String() string
func (request ListSdksRequest) ValidateEnumValue() (bool, error)
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
ListSdksResponse wrapper for the ListSdks operation
type ListSdksResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SdkCollection instances
SdkCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListSdksResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSdksResponse) String() string
ListSdksSortByEnum Enum with underlying type: string
type ListSdksSortByEnum string
Set of constants representing the allowable values for ListSdksSortByEnum
const (
ListSdksSortByTimecreated ListSdksSortByEnum = "timeCreated"
ListSdksSortByDisplayname ListSdksSortByEnum = "displayName"
)
func GetListSdksSortByEnumValues() []ListSdksSortByEnum
GetListSdksSortByEnumValues Enumerates the set of values for ListSdksSortByEnum
func GetMappingListSdksSortByEnum(val string) (ListSdksSortByEnum, bool)
GetMappingListSdksSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSdksSortOrderEnum Enum with underlying type: string
type ListSdksSortOrderEnum string
Set of constants representing the allowable values for ListSdksSortOrderEnum
const (
ListSdksSortOrderAsc ListSdksSortOrderEnum = "ASC"
ListSdksSortOrderDesc ListSdksSortOrderEnum = "DESC"
)
func GetListSdksSortOrderEnumValues() []ListSdksSortOrderEnum
GetListSdksSortOrderEnumValues Enumerates the set of values for ListSdksSortOrderEnum
func GetMappingListSdksSortOrderEnum(val string) (ListSdksSortOrderEnum, bool)
GetMappingListSdksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscribersRequest wrapper for the ListSubscribers operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListSubscribers.go.html to see an example of how to use ListSubscribersRequest.
type ListSubscribersRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state.
// Example: `ACTIVE`
LifecycleState SubscriberLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListSubscribersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListSubscribersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request id for tracing.
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
}
func (request ListSubscribersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscribersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscribersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscribersRequest) String() string
func (request ListSubscribersRequest) ValidateEnumValue() (bool, error)
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
ListSubscribersResponse wrapper for the ListSubscribers operation
type ListSubscribersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SubscriberCollection instances
SubscriberCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListSubscribersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscribersResponse) String() string
ListSubscribersSortByEnum Enum with underlying type: string
type ListSubscribersSortByEnum string
Set of constants representing the allowable values for ListSubscribersSortByEnum
const (
ListSubscribersSortByTimecreated ListSubscribersSortByEnum = "timeCreated"
ListSubscribersSortByDisplayname ListSubscribersSortByEnum = "displayName"
)
func GetListSubscribersSortByEnumValues() []ListSubscribersSortByEnum
GetListSubscribersSortByEnumValues Enumerates the set of values for ListSubscribersSortByEnum
func GetMappingListSubscribersSortByEnum(val string) (ListSubscribersSortByEnum, bool)
GetMappingListSubscribersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscribersSortOrderEnum Enum with underlying type: string
type ListSubscribersSortOrderEnum string
Set of constants representing the allowable values for ListSubscribersSortOrderEnum
const (
ListSubscribersSortOrderAsc ListSubscribersSortOrderEnum = "ASC"
ListSubscribersSortOrderDesc ListSubscribersSortOrderEnum = "DESC"
)
func GetListSubscribersSortOrderEnumValues() []ListSubscribersSortOrderEnum
GetListSubscribersSortOrderEnumValues Enumerates the set of values for ListSubscribersSortOrderEnum
func GetMappingListSubscribersSortOrderEnum(val string) (ListSubscribersSortOrderEnum, bool)
GetMappingListSubscribersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListUsagePlansRequest wrapper for the ListUsagePlans operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListUsagePlans.go.html to see an example of how to use ListUsagePlansRequest.
type ListUsagePlansRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given lifecycle state.
// Example: `ACTIVE`
LifecycleState UsagePlanLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListUsagePlansSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListUsagePlansSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request id for tracing.
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
}
func (request ListUsagePlansRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListUsagePlansRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListUsagePlansRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListUsagePlansRequest) String() string
func (request ListUsagePlansRequest) ValidateEnumValue() (bool, error)
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
ListUsagePlansResponse wrapper for the ListUsagePlans operation
type ListUsagePlansResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of UsagePlanCollection instances
UsagePlanCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListUsagePlansResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListUsagePlansResponse) String() string
ListUsagePlansSortByEnum Enum with underlying type: string
type ListUsagePlansSortByEnum string
Set of constants representing the allowable values for ListUsagePlansSortByEnum
const (
ListUsagePlansSortByTimecreated ListUsagePlansSortByEnum = "timeCreated"
ListUsagePlansSortByDisplayname ListUsagePlansSortByEnum = "displayName"
)
func GetListUsagePlansSortByEnumValues() []ListUsagePlansSortByEnum
GetListUsagePlansSortByEnumValues Enumerates the set of values for ListUsagePlansSortByEnum
func GetMappingListUsagePlansSortByEnum(val string) (ListUsagePlansSortByEnum, bool)
GetMappingListUsagePlansSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListUsagePlansSortOrderEnum Enum with underlying type: string
type ListUsagePlansSortOrderEnum string
Set of constants representing the allowable values for ListUsagePlansSortOrderEnum
const (
ListUsagePlansSortOrderAsc ListUsagePlansSortOrderEnum = "ASC"
ListUsagePlansSortOrderDesc ListUsagePlansSortOrderEnum = "DESC"
)
func GetListUsagePlansSortOrderEnumValues() []ListUsagePlansSortOrderEnum
GetListUsagePlansSortOrderEnumValues Enumerates the set of values for ListUsagePlansSortOrderEnum
func GetMappingListUsagePlansSortOrderEnum(val string) (ListUsagePlansSortOrderEnum, bool)
GetMappingListUsagePlansSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ocid of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request id for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// 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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
// 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"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
ListWorkRequestErrorsSortByDisplayname ListWorkRequestErrorsSortByEnum = "displayName"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ocid of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request id for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogCollection instances
WorkRequestLogCollection `presentIn:"body"`
// 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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
// 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"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
ListWorkRequestLogsSortByDisplayname ListWorkRequestLogsSortByEnum = "displayName"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ocid of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Filter work requests by the resource ocid.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request id for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
// Default order for `timeCreated` is descending. Default order for
// `displayName` is ascending. The `displayName` sort order is case
// sensitive.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestCollection instances
WorkRequestCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results were seen previously. For important details
// about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimecreated ListWorkRequestsSortByEnum = "timeCreated"
ListWorkRequestsSortByDisplayname ListWorkRequestsSortByEnum = "displayName"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ModifyResponseValidationFailurePolicy Policy to specify how to modify the response code, body and headers.
type ModifyResponseValidationFailurePolicy struct {
// HTTP response code, can include context variables.
ResponseCode *string `mandatory:"false" json:"responseCode"`
// HTTP response message.
ResponseMessage *string `mandatory:"false" json:"responseMessage"`
ResponseHeaderTransformations *HeaderTransformationPolicy `mandatory:"false" json:"responseHeaderTransformations"`
}
func (m ModifyResponseValidationFailurePolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ModifyResponseValidationFailurePolicy) String() string
func (m ModifyResponseValidationFailurePolicy) ValidateEnumValue() (bool, error)
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
MutualTlsDetails Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
type MutualTlsDetails struct {
// Determines whether to enable client verification when API Consumer makes connection to the gateway.
IsVerifiedCertificateRequired *bool `mandatory:"false" json:"isVerifiedCertificateRequired"`
// Allowed list of CN or SAN which will be used for verification of certificate.
AllowedSans []string `mandatory:"false" json:"allowedSans"`
}
func (m MutualTlsDetails) String() string
func (m MutualTlsDetails) ValidateEnumValue() (bool, error)
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
NoCache Configures the gateway with no caching. Cache lookup and store policies will not be supported.
type NoCache struct {
}
func (m NoCache) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NoCache) String() string
func (m NoCache) ValidateEnumValue() (bool, error)
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
NoContentValidation No content validation properties.
type NoContentValidation struct {
}
func (m NoContentValidation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NoContentValidation) String() string
func (m NoContentValidation) ValidateEnumValue() (bool, error)
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
OAuth2LogoutBackend Backend which when called triggers OAuth2 logout.
type OAuth2LogoutBackend struct {
AllowedPostLogoutUris []string `mandatory:"false" json:"allowedPostLogoutUris"`
// Defines a state that should be shared on redirecting to postLogout URL.
PostLogoutState *string `mandatory:"false" json:"postLogoutState"`
}
func (m OAuth2LogoutBackend) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OAuth2LogoutBackend) String() string
func (m OAuth2LogoutBackend) ValidateEnumValue() (bool, error)
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
OAuth2ResponseValidationFailurePolicy Policy to specify OAuth2 flow configuration.
type OAuth2ResponseValidationFailurePolicy struct {
ClientDetails ClientAppDetails `mandatory:"true" json:"clientDetails"`
SourceUriDetails SourceUriDetails `mandatory:"true" json:"sourceUriDetails"`
// List of scopes.
Scopes []string `mandatory:"true" json:"scopes"`
// The duration for which the OAuth2 success token should be cached before it is
// fetched again.
MaxExpiryDurationInHours *int `mandatory:"false" json:"maxExpiryDurationInHours"`
// Defines whether or not to use cookies for session maintenance.
UseCookiesForSession *bool `mandatory:"false" json:"useCookiesForSession"`
// Defines whether or not to use cookies for OAuth2 intermediate steps.
UseCookiesForIntermediateSteps *bool `mandatory:"false" json:"useCookiesForIntermediateSteps"`
// Defines whether or not to support PKCE.
UsePkce *bool `mandatory:"false" json:"usePkce"`
// The path to be used as fallback after OAuth2.
FallbackRedirectPath *string `mandatory:"false" json:"fallbackRedirectPath"`
// The path to be used as logout.
LogoutPath *string `mandatory:"false" json:"logoutPath"`
// Response Type.
ResponseType OAuth2ResponseValidationFailurePolicyResponseTypeEnum `mandatory:"true" json:"responseType"`
}
func (m OAuth2ResponseValidationFailurePolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OAuth2ResponseValidationFailurePolicy) String() string
func (m *OAuth2ResponseValidationFailurePolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m OAuth2ResponseValidationFailurePolicy) ValidateEnumValue() (bool, error)
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
OAuth2ResponseValidationFailurePolicyResponseTypeEnum Enum with underlying type: string
type OAuth2ResponseValidationFailurePolicyResponseTypeEnum string
Set of constants representing the allowable values for OAuth2ResponseValidationFailurePolicyResponseTypeEnum
const (
OAuth2ResponseValidationFailurePolicyResponseTypeCode OAuth2ResponseValidationFailurePolicyResponseTypeEnum = "CODE"
)
func GetMappingOAuth2ResponseValidationFailurePolicyResponseTypeEnum(val string) (OAuth2ResponseValidationFailurePolicyResponseTypeEnum, bool)
GetMappingOAuth2ResponseValidationFailurePolicyResponseTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumValues() []OAuth2ResponseValidationFailurePolicyResponseTypeEnum
GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumValues Enumerates the set of values for OAuth2ResponseValidationFailurePolicyResponseTypeEnum
OracleFunctionBackend Send the request to an Oracle Functions function.
type OracleFunctionBackend struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.
FunctionId *string `mandatory:"true" json:"functionId"`
}
func (m OracleFunctionBackend) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OracleFunctionBackend) String() string
func (m OracleFunctionBackend) ValidateEnumValue() (bool, error)
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
PemEncodedPublicKey A PEM-encoded public key used for verifying the JWT signature.
type PemEncodedPublicKey struct {
// A unique key ID. This key will be used to verify the signature of a
// JWT with matching "kid".
Kid *string `mandatory:"true" json:"kid"`
// The content of the PEM-encoded public key.
Key *string `mandatory:"true" json:"key"`
}
func (m PemEncodedPublicKey) GetKid() *string
GetKid returns Kid
func (m PemEncodedPublicKey) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PemEncodedPublicKey) String() string
func (m PemEncodedPublicKey) ValidateEnumValue() (bool, error)
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
PublicKeySet A set of Public Keys that will be used to verify the JWT signature.
type PublicKeySet interface {
}
PublicKeySetTypeEnum Enum with underlying type: string
type PublicKeySetTypeEnum string
Set of constants representing the allowable values for PublicKeySetTypeEnum
const (
PublicKeySetTypeStaticKeys PublicKeySetTypeEnum = "STATIC_KEYS"
PublicKeySetTypeRemoteJwks PublicKeySetTypeEnum = "REMOTE_JWKS"
)
func GetMappingPublicKeySetTypeEnum(val string) (PublicKeySetTypeEnum, bool)
GetMappingPublicKeySetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPublicKeySetTypeEnumValues() []PublicKeySetTypeEnum
GetPublicKeySetTypeEnumValues Enumerates the set of values for PublicKeySetTypeEnum
QueryParameterTransformationPolicy A set of transformations to apply to query parameters that pass through the gateway.
type QueryParameterTransformationPolicy struct {
SetQueryParameters *SetQueryParameterPolicy `mandatory:"false" json:"setQueryParameters"`
RenameQueryParameters *RenameQueryParameterPolicy `mandatory:"false" json:"renameQueryParameters"`
FilterQueryParameters *FilterQueryParameterPolicy `mandatory:"false" json:"filterQueryParameters"`
}
func (m QueryParameterTransformationPolicy) String() string
func (m QueryParameterTransformationPolicy) ValidateEnumValue() (bool, error)
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
QueryParameterValidationItem Query parameter validation properties.
type QueryParameterValidationItem struct {
// Parameter name.
Name *string `mandatory:"true" json:"name"`
// Determines if the parameter is required in the request.
Required *bool `mandatory:"false" json:"required"`
}
func (m QueryParameterValidationItem) String() string
func (m QueryParameterValidationItem) ValidateEnumValue() (bool, error)
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
QueryParameterValidationRequestPolicy Validate the URL query parameters on the incoming API requests on a specific route.
type QueryParameterValidationRequestPolicy struct {
// Validation behavior mode.
// In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response
// and not sent to the backend.
// In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request
// will follow the normal path.
// `DISABLED` type turns the validation off.
ValidationMode QueryParameterValidationRequestPolicyValidationModeEnum `mandatory:"false" json:"validationMode,omitempty"`
Parameters []QueryParameterValidationItem `mandatory:"false" json:"parameters"`
}
func (m QueryParameterValidationRequestPolicy) String() string
func (m QueryParameterValidationRequestPolicy) ValidateEnumValue() (bool, error)
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
QueryParameterValidationRequestPolicyValidationModeEnum Enum with underlying type: string
type QueryParameterValidationRequestPolicyValidationModeEnum string
Set of constants representing the allowable values for QueryParameterValidationRequestPolicyValidationModeEnum
const (
QueryParameterValidationRequestPolicyValidationModeEnforcing QueryParameterValidationRequestPolicyValidationModeEnum = "ENFORCING"
QueryParameterValidationRequestPolicyValidationModePermissive QueryParameterValidationRequestPolicyValidationModeEnum = "PERMISSIVE"
QueryParameterValidationRequestPolicyValidationModeDisabled QueryParameterValidationRequestPolicyValidationModeEnum = "DISABLED"
)
func GetMappingQueryParameterValidationRequestPolicyValidationModeEnum(val string) (QueryParameterValidationRequestPolicyValidationModeEnum, bool)
GetMappingQueryParameterValidationRequestPolicyValidationModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQueryParameterValidationRequestPolicyValidationModeEnumValues() []QueryParameterValidationRequestPolicyValidationModeEnum
GetQueryParameterValidationRequestPolicyValidationModeEnumValues Enumerates the set of values for QueryParameterValidationRequestPolicyValidationModeEnum
Quota Quota policy for a usage plan.
type Quota struct {
// The number of requests that can be made per time period.
Value *int `mandatory:"true" json:"value"`
// The unit of time over which quotas are calculated.
// Example: `MINUTE` or `MONTH`
Unit QuotaUnitEnum `mandatory:"true" json:"unit"`
// The policy that controls when quotas will reset.
// Example: `CALENDAR`
ResetPolicy QuotaResetPolicyEnum `mandatory:"true" json:"resetPolicy"`
// What the usage plan will do when a quota is breached:
// `REJECT` will allow no further requests
// `ALLOW` will continue to allow further requests
OperationOnBreach QuotaOperationOnBreachEnum `mandatory:"true" json:"operationOnBreach"`
}
func (m Quota) String() string
func (m Quota) ValidateEnumValue() (bool, error)
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
QuotaOperationOnBreachEnum Enum with underlying type: string
type QuotaOperationOnBreachEnum string
Set of constants representing the allowable values for QuotaOperationOnBreachEnum
const (
QuotaOperationOnBreachReject QuotaOperationOnBreachEnum = "REJECT"
QuotaOperationOnBreachAllow QuotaOperationOnBreachEnum = "ALLOW"
)
func GetMappingQuotaOperationOnBreachEnum(val string) (QuotaOperationOnBreachEnum, bool)
GetMappingQuotaOperationOnBreachEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQuotaOperationOnBreachEnumValues() []QuotaOperationOnBreachEnum
GetQuotaOperationOnBreachEnumValues Enumerates the set of values for QuotaOperationOnBreachEnum
QuotaResetPolicyEnum Enum with underlying type: string
type QuotaResetPolicyEnum string
Set of constants representing the allowable values for QuotaResetPolicyEnum
const (
QuotaResetPolicyCalendar QuotaResetPolicyEnum = "CALENDAR"
)
func GetMappingQuotaResetPolicyEnum(val string) (QuotaResetPolicyEnum, bool)
GetMappingQuotaResetPolicyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQuotaResetPolicyEnumValues() []QuotaResetPolicyEnum
GetQuotaResetPolicyEnumValues Enumerates the set of values for QuotaResetPolicyEnum
QuotaUnitEnum Enum with underlying type: string
type QuotaUnitEnum string
Set of constants representing the allowable values for QuotaUnitEnum
const (
QuotaUnitMinute QuotaUnitEnum = "MINUTE"
QuotaUnitHour QuotaUnitEnum = "HOUR"
QuotaUnitDay QuotaUnitEnum = "DAY"
QuotaUnitWeek QuotaUnitEnum = "WEEK"
QuotaUnitMonth QuotaUnitEnum = "MONTH"
)
func GetMappingQuotaUnitEnum(val string) (QuotaUnitEnum, bool)
GetMappingQuotaUnitEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQuotaUnitEnumValues() []QuotaUnitEnum
GetQuotaUnitEnumValues Enumerates the set of values for QuotaUnitEnum
RateLimit Rate-limiting policy for a usage plan.
type RateLimit struct {
// The number of requests that can be made per time period.
Value *int `mandatory:"true" json:"value"`
// The unit of time over which rate limits are calculated.
// Example: `SECOND`
Unit RateLimitUnitEnum `mandatory:"true" json:"unit"`
}
func (m RateLimit) String() string
func (m RateLimit) ValidateEnumValue() (bool, error)
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
RateLimitUnitEnum Enum with underlying type: string
type RateLimitUnitEnum string
Set of constants representing the allowable values for RateLimitUnitEnum
const (
RateLimitUnitSecond RateLimitUnitEnum = "SECOND"
)
func GetMappingRateLimitUnitEnum(val string) (RateLimitUnitEnum, bool)
GetMappingRateLimitUnitEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRateLimitUnitEnumValues() []RateLimitUnitEnum
GetRateLimitUnitEnumValues Enumerates the set of values for RateLimitUnitEnum
RateLimitingPolicy Limit the number of requests that should be handled for the specified window using a specfic key.
type RateLimitingPolicy struct {
// The maximum number of requests per second to allow.
RateInRequestsPerSecond *int `mandatory:"true" json:"rateInRequestsPerSecond"`
// The key used to group requests together.
RateKey RateLimitingPolicyRateKeyEnum `mandatory:"true" json:"rateKey"`
}
func (m RateLimitingPolicy) String() string
func (m RateLimitingPolicy) ValidateEnumValue() (bool, error)
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
RateLimitingPolicyRateKeyEnum Enum with underlying type: string
type RateLimitingPolicyRateKeyEnum string
Set of constants representing the allowable values for RateLimitingPolicyRateKeyEnum
const (
RateLimitingPolicyRateKeyClientIp RateLimitingPolicyRateKeyEnum = "CLIENT_IP"
RateLimitingPolicyRateKeyTotal RateLimitingPolicyRateKeyEnum = "TOTAL"
)
func GetMappingRateLimitingPolicyRateKeyEnum(val string) (RateLimitingPolicyRateKeyEnum, bool)
GetMappingRateLimitingPolicyRateKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRateLimitingPolicyRateKeyEnumValues() []RateLimitingPolicyRateKeyEnum
GetRateLimitingPolicyRateKeyEnumValues Enumerates the set of values for RateLimitingPolicyRateKeyEnum
RemoteJsonWebKeySet A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. The set should only contain JWK-formatted keys.
type RemoteJsonWebKeySet struct {
// The uri from which to retrieve the key. It must be accessible
// without authentication.
Uri *string `mandatory:"true" json:"uri"`
// Defines whether or not to uphold SSL verification.
IsSslVerifyDisabled *bool `mandatory:"false" json:"isSslVerifyDisabled"`
// The duration for which the JWKS should be cached before it is
// fetched again.
MaxCacheDurationInHours *int `mandatory:"false" json:"maxCacheDurationInHours"`
}
func (m RemoteJsonWebKeySet) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RemoteJsonWebKeySet) String() string
func (m RemoteJsonWebKeySet) ValidateEnumValue() (bool, error)
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
RenameHeaderPolicy Rename HTTP headers as they pass through the gateway.
type RenameHeaderPolicy struct {
// The list of headers.
Items []RenameHeaderPolicyItem `mandatory:"true" json:"items"`
}
func (m RenameHeaderPolicy) String() string
func (m RenameHeaderPolicy) ValidateEnumValue() (bool, error)
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
RenameHeaderPolicyItem The value will be a copy of the original value of the source header and will not be affected by any other transformation policies applied to that header.
type RenameHeaderPolicyItem struct {
// The original case-insensitive name of the header. This name must be unique across transformation policies.
From *string `mandatory:"true" json:"from"`
// The new name of the header. This name must be unique across transformation policies.
To *string `mandatory:"true" json:"to"`
}
func (m RenameHeaderPolicyItem) String() string
func (m RenameHeaderPolicyItem) ValidateEnumValue() (bool, error)
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
RenameQueryParameterPolicy Rename parameters on the query string as they pass through the gateway.
type RenameQueryParameterPolicy struct {
// The list of query parameters.
Items []RenameQueryParameterPolicyItem `mandatory:"true" json:"items"`
}
func (m RenameQueryParameterPolicy) String() string
func (m RenameQueryParameterPolicy) ValidateEnumValue() (bool, error)
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
RenameQueryParameterPolicyItem The value will be a copy of the original value of the source parameter and will not be affected by any other transformation policies applied to that parameter.
type RenameQueryParameterPolicyItem struct {
// The original case-sensitive name of the query parameter. This name must be unique across transformation
// policies.
From *string `mandatory:"true" json:"from"`
// The new name of the query parameter. This name must be unique across transformation policies.
To *string `mandatory:"true" json:"to"`
}
func (m RenameQueryParameterPolicyItem) String() string
func (m RenameQueryParameterPolicyItem) ValidateEnumValue() (bool, error)
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
RequestParameterValidation Common parameter validation properties.
type RequestParameterValidation struct {
// Parameter name.
Name *string `mandatory:"true" json:"name"`
}
func (m RequestParameterValidation) String() string
func (m RequestParameterValidation) ValidateEnumValue() (bool, error)
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
ResponseCacheDetails Base Gateway response cache.
type ResponseCacheDetails interface {
}
ResponseCacheDetailsTypeEnum Enum with underlying type: string
type ResponseCacheDetailsTypeEnum string
Set of constants representing the allowable values for ResponseCacheDetailsTypeEnum
const (
ResponseCacheDetailsTypeExternalRespCache ResponseCacheDetailsTypeEnum = "EXTERNAL_RESP_CACHE"
ResponseCacheDetailsTypeNone ResponseCacheDetailsTypeEnum = "NONE"
)
func GetMappingResponseCacheDetailsTypeEnum(val string) (ResponseCacheDetailsTypeEnum, bool)
GetMappingResponseCacheDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResponseCacheDetailsTypeEnumValues() []ResponseCacheDetailsTypeEnum
GetResponseCacheDetailsTypeEnumValues Enumerates the set of values for ResponseCacheDetailsTypeEnum
ResponseCacheLookupPolicy Base policy for Response Cache lookup.
type ResponseCacheLookupPolicy interface {
// Whether this policy is currently enabled.
GetIsEnabled() *bool
// Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your
// cache key additions to get the level of isolation across authenticated requests that you require.
// When false, any request with an Authorization header will not be stored in the Response Cache.
// If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check.
GetIsPrivateCachingEnabled() *bool
}
ResponseCacheLookupPolicyTypeEnum Enum with underlying type: string
type ResponseCacheLookupPolicyTypeEnum string
Set of constants representing the allowable values for ResponseCacheLookupPolicyTypeEnum
const (
ResponseCacheLookupPolicyTypeSimpleLookupPolicy ResponseCacheLookupPolicyTypeEnum = "SIMPLE_LOOKUP_POLICY"
)
func GetMappingResponseCacheLookupPolicyTypeEnum(val string) (ResponseCacheLookupPolicyTypeEnum, bool)
GetMappingResponseCacheLookupPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResponseCacheLookupPolicyTypeEnumValues() []ResponseCacheLookupPolicyTypeEnum
GetResponseCacheLookupPolicyTypeEnumValues Enumerates the set of values for ResponseCacheLookupPolicyTypeEnum
ResponseCacheRespServer Details of a RESP based cache store server
type ResponseCacheRespServer struct {
// Hostname or IP address (IPv4 only) where the cache store is running.
Host *string `mandatory:"true" json:"host"`
// The port the cache store is exposed on.
Port *int `mandatory:"true" json:"port"`
}
func (m ResponseCacheRespServer) String() string
func (m ResponseCacheRespServer) ValidateEnumValue() (bool, error)
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
ResponseCacheStorePolicy Base policy for how a response from a backend is cached in the Response Cache.
type ResponseCacheStorePolicy interface {
}
ResponseCacheStorePolicyTypeEnum Enum with underlying type: string
type ResponseCacheStorePolicyTypeEnum string
Set of constants representing the allowable values for ResponseCacheStorePolicyTypeEnum
const (
ResponseCacheStorePolicyTypeFixedTtlStorePolicy ResponseCacheStorePolicyTypeEnum = "FIXED_TTL_STORE_POLICY"
)
func GetMappingResponseCacheStorePolicyTypeEnum(val string) (ResponseCacheStorePolicyTypeEnum, bool)
GetMappingResponseCacheStorePolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResponseCacheStorePolicyTypeEnumValues() []ResponseCacheStorePolicyTypeEnum
GetResponseCacheStorePolicyTypeEnumValues Enumerates the set of values for ResponseCacheStorePolicyTypeEnum
RouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
type RouteAuthorizationPolicy interface {
}
RouteAuthorizationPolicyTypeEnum Enum with underlying type: string
type RouteAuthorizationPolicyTypeEnum string
Set of constants representing the allowable values for RouteAuthorizationPolicyTypeEnum
const (
RouteAuthorizationPolicyTypeAnonymous RouteAuthorizationPolicyTypeEnum = "ANONYMOUS"
RouteAuthorizationPolicyTypeAnyOf RouteAuthorizationPolicyTypeEnum = "ANY_OF"
RouteAuthorizationPolicyTypeAuthenticationOnly RouteAuthorizationPolicyTypeEnum = "AUTHENTICATION_ONLY"
)
func GetMappingRouteAuthorizationPolicyTypeEnum(val string) (RouteAuthorizationPolicyTypeEnum, bool)
GetMappingRouteAuthorizationPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRouteAuthorizationPolicyTypeEnumValues() []RouteAuthorizationPolicyTypeEnum
GetRouteAuthorizationPolicyTypeEnumValues Enumerates the set of values for RouteAuthorizationPolicyTypeEnum
Sdk Information about the SDK.
type Sdk struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of API resource
ApiId *string `mandatory:"true" json:"apiId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"true" json:"displayName"`
// The string representing the target programming language for generating the SDK.
TargetLanguage *string `mandatory:"true" json:"targetLanguage"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// File location for generated SDK.
ArtifactUrl *string `mandatory:"false" json:"artifactUrl"`
// Expiry of artifact url.
TimeArtifactUrlExpiresAt *common.SDKTime `mandatory:"false" json:"timeArtifactUrlExpiresAt"`
// The current state of the SDK.
// - The SDK will be in CREATING state if the SDK creation is in progress.
// - The SDK will be in ACTIVE state if create is successful.
// - The SDK will be in FAILED state if the create, or delete fails.
// - The SDK will be in DELETING state if the deletion in in progress.
// - The SDK will be in DELETED state if the delete is successful.
LifecycleState SdkLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Additional optional configurations passed.
// The applicable config keys are listed under "parameters" when "/sdkLanguageTypes" is called.
// Example: `{"configName": "configValue"}`
Parameters map[string]string `mandatory:"false" json:"parameters"`
}
func (m Sdk) String() string
func (m Sdk) ValidateEnumValue() (bool, error)
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
SdkCollection Collection of the existing SDKs.
type SdkCollection struct {
// SDK summaries.
Items []SdkSummary `mandatory:"true" json:"items"`
}
func (m SdkCollection) String() string
func (m SdkCollection) ValidateEnumValue() (bool, error)
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
SdkLanguageOptionalParameters List of additional applicable parameters for any given target language.
type SdkLanguageOptionalParameters struct {
// Name of the parameter.
ParamName *string `mandatory:"true" json:"paramName"`
// Display name of the parameter.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description for the parameter.
Description *string `mandatory:"false" json:"description"`
// Information on whether the parameter is required or not.
IsRequired *bool `mandatory:"false" json:"isRequired"`
// Maximum size as input value for this parameter.
MaxSize *float32 `mandatory:"false" json:"maxSize"`
// The input type for this param.
// - Input type is ENUM when only specific list of input strings are allowed.
// - Input type is EMAIL when input type is an email ID.
// - Input type is URI when input type is an URI.
// - Input type is STRING in all other cases.
InputType SdkLanguageOptionalParametersInputTypeEnum `mandatory:"false" json:"inputType,omitempty"`
// List of allowed input values.
// Example: `[{"name": "name1", "description": "description1"}, ...]`
AllowedValues []SdkLanguageOptionalParametersAllowedValue `mandatory:"false" json:"allowedValues"`
}
func (m SdkLanguageOptionalParameters) String() string
func (m SdkLanguageOptionalParameters) ValidateEnumValue() (bool, error)
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
SdkLanguageOptionalParametersAllowedValue Allowed value object.
type SdkLanguageOptionalParametersAllowedValue struct {
// Name of the allowed value.
Name *string `mandatory:"false" json:"name"`
// Description for the allowed value.
Description *string `mandatory:"false" json:"description"`
}
func (m SdkLanguageOptionalParametersAllowedValue) String() string
func (m SdkLanguageOptionalParametersAllowedValue) ValidateEnumValue() (bool, error)
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
SdkLanguageOptionalParametersInputTypeEnum Enum with underlying type: string
type SdkLanguageOptionalParametersInputTypeEnum string
Set of constants representing the allowable values for SdkLanguageOptionalParametersInputTypeEnum
const (
SdkLanguageOptionalParametersInputTypeEnumvalue SdkLanguageOptionalParametersInputTypeEnum = "ENUM"
SdkLanguageOptionalParametersInputTypeEmail SdkLanguageOptionalParametersInputTypeEnum = "EMAIL"
SdkLanguageOptionalParametersInputTypeUri SdkLanguageOptionalParametersInputTypeEnum = "URI"
SdkLanguageOptionalParametersInputTypeString SdkLanguageOptionalParametersInputTypeEnum = "STRING"
)
func GetMappingSdkLanguageOptionalParametersInputTypeEnum(val string) (SdkLanguageOptionalParametersInputTypeEnum, bool)
GetMappingSdkLanguageOptionalParametersInputTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSdkLanguageOptionalParametersInputTypeEnumValues() []SdkLanguageOptionalParametersInputTypeEnum
GetSdkLanguageOptionalParametersInputTypeEnumValues Enumerates the set of values for SdkLanguageOptionalParametersInputTypeEnum
SdkLanguageTypeCollection Collection of available SDK target languages.
type SdkLanguageTypeCollection struct {
// SDK target language details.
Items []SdkLanguageTypeSummary `mandatory:"true" json:"items"`
}
func (m SdkLanguageTypeCollection) String() string
func (m SdkLanguageTypeCollection) ValidateEnumValue() (bool, error)
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
SdkLanguageTypeSummary SDK target language details.
type SdkLanguageTypeSummary struct {
// Name of the programming language.
Name *string `mandatory:"true" json:"name"`
// Version string of the programming language defined in name.
Version *string `mandatory:"true" json:"version"`
// Display name of the target programming language.
DisplayName *string `mandatory:"false" json:"displayName"`
// Additional details.
Description *string `mandatory:"false" json:"description"`
// List of optional configurations that can be used while generating SDK for the given target language.
Parameters []SdkLanguageOptionalParameters `mandatory:"false" json:"parameters"`
}
func (m SdkLanguageTypeSummary) String() string
func (m SdkLanguageTypeSummary) ValidateEnumValue() (bool, error)
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
SdkLanguageTypes SDK target language details.
type SdkLanguageTypes struct {
// Name of the programming language.
Name *string `mandatory:"true" json:"name"`
// Version string of the programming language defined in name.
Version *string `mandatory:"true" json:"version"`
// Display name of the target programming language.
DisplayName *string `mandatory:"false" json:"displayName"`
// Additional details.
Description *string `mandatory:"false" json:"description"`
// List of optional configurations that can be used while generating SDK for the given target language.
Parameters []SdkLanguageOptionalParameters `mandatory:"false" json:"parameters"`
}
func (m SdkLanguageTypes) String() string
func (m SdkLanguageTypes) ValidateEnumValue() (bool, error)
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
SdkLifecycleStateEnum Enum with underlying type: string
type SdkLifecycleStateEnum string
Set of constants representing the allowable values for SdkLifecycleStateEnum
const (
SdkLifecycleStateCreating SdkLifecycleStateEnum = "CREATING"
SdkLifecycleStateActive SdkLifecycleStateEnum = "ACTIVE"
SdkLifecycleStateFailed SdkLifecycleStateEnum = "FAILED"
SdkLifecycleStateDeleting SdkLifecycleStateEnum = "DELETING"
SdkLifecycleStateDeleted SdkLifecycleStateEnum = "DELETED"
)
func GetMappingSdkLifecycleStateEnum(val string) (SdkLifecycleStateEnum, bool)
GetMappingSdkLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSdkLifecycleStateEnumValues() []SdkLifecycleStateEnum
GetSdkLifecycleStateEnumValues Enumerates the set of values for SdkLifecycleStateEnum
SdkSummary A summary of the SDK.
type SdkSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"true" json:"displayName"`
// The string representing the target programming language for generating the SDK.
TargetLanguage *string `mandatory:"true" json:"targetLanguage"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the SDK.
LifecycleState SdkLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m SdkSummary) String() string
func (m SdkSummary) ValidateEnumValue() (bool, error)
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
SelectionSourcePolicy The type of selector to use when dynamically routing and dynamically authenticating requests.
type SelectionSourcePolicy interface {
}
SelectionSourcePolicyTypeEnum Enum with underlying type: string
type SelectionSourcePolicyTypeEnum string
Set of constants representing the allowable values for SelectionSourcePolicyTypeEnum
const (
SelectionSourcePolicyTypeSingle SelectionSourcePolicyTypeEnum = "SINGLE"
)
func GetMappingSelectionSourcePolicyTypeEnum(val string) (SelectionSourcePolicyTypeEnum, bool)
GetMappingSelectionSourcePolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSelectionSourcePolicyTypeEnumValues() []SelectionSourcePolicyTypeEnum
GetSelectionSourcePolicyTypeEnumValues Enumerates the set of values for SelectionSourcePolicyTypeEnum
SetHeaderPolicy Set HTTP headers as they pass through the gateway.
type SetHeaderPolicy struct {
// The list of headers.
Items []SetHeaderPolicyItem `mandatory:"true" json:"items"`
}
func (m SetHeaderPolicy) String() string
func (m SetHeaderPolicy) ValidateEnumValue() (bool, error)
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
SetHeaderPolicyItem Set will add a new header if it was not in the original request. If the header already exists on the request, you can choose to override, append, or skip it.
type SetHeaderPolicyItem struct {
// The case-insensitive name of the header. This name must be unique across transformation policies.
Name *string `mandatory:"true" json:"name"`
// A list of new values. Each value can be a constant or may include one or more expressions enclosed within
// ${} delimiters.
Values []string `mandatory:"true" json:"values"`
// If a header with the same name already exists in the request, OVERWRITE will overwrite the value,
// APPEND will append to the existing value, or SKIP will keep the existing value.
IfExists SetHeaderPolicyItemIfExistsEnum `mandatory:"false" json:"ifExists,omitempty"`
}
func (m SetHeaderPolicyItem) String() string
func (m SetHeaderPolicyItem) ValidateEnumValue() (bool, error)
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
SetHeaderPolicyItemIfExistsEnum Enum with underlying type: string
type SetHeaderPolicyItemIfExistsEnum string
Set of constants representing the allowable values for SetHeaderPolicyItemIfExistsEnum
const (
SetHeaderPolicyItemIfExistsOverwrite SetHeaderPolicyItemIfExistsEnum = "OVERWRITE"
SetHeaderPolicyItemIfExistsAppend SetHeaderPolicyItemIfExistsEnum = "APPEND"
SetHeaderPolicyItemIfExistsSkip SetHeaderPolicyItemIfExistsEnum = "SKIP"
)
func GetMappingSetHeaderPolicyItemIfExistsEnum(val string) (SetHeaderPolicyItemIfExistsEnum, bool)
GetMappingSetHeaderPolicyItemIfExistsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSetHeaderPolicyItemIfExistsEnumValues() []SetHeaderPolicyItemIfExistsEnum
GetSetHeaderPolicyItemIfExistsEnumValues Enumerates the set of values for SetHeaderPolicyItemIfExistsEnum
SetQueryParameterPolicy Set parameters on the query string as they pass through the gateway.
type SetQueryParameterPolicy struct {
// The list of query parameters.
Items []SetQueryParameterPolicyItem `mandatory:"true" json:"items"`
}
func (m SetQueryParameterPolicy) String() string
func (m SetQueryParameterPolicy) ValidateEnumValue() (bool, error)
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
SetQueryParameterPolicyItem Set will add a new query parameter if it was not in the original request. If the parameter already exists on the request, you can choose to override, append, or skip it.
type SetQueryParameterPolicyItem struct {
// The case-sensitive name of the query parameter. This name must be unique across transformation policies.
Name *string `mandatory:"true" json:"name"`
// A list of new values. Each value can be a constant or may include one or more expressions enclosed within
// ${} delimiters.
Values []string `mandatory:"true" json:"values"`
// If a query parameter with the same name already exists in the request, OVERWRITE will overwrite the value,
// APPEND will append to the existing value, or SKIP will keep the existing value.
IfExists SetQueryParameterPolicyItemIfExistsEnum `mandatory:"false" json:"ifExists,omitempty"`
}
func (m SetQueryParameterPolicyItem) String() string
func (m SetQueryParameterPolicyItem) ValidateEnumValue() (bool, error)
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
SetQueryParameterPolicyItemIfExistsEnum Enum with underlying type: string
type SetQueryParameterPolicyItemIfExistsEnum string
Set of constants representing the allowable values for SetQueryParameterPolicyItemIfExistsEnum
const (
SetQueryParameterPolicyItemIfExistsOverwrite SetQueryParameterPolicyItemIfExistsEnum = "OVERWRITE"
SetQueryParameterPolicyItemIfExistsAppend SetQueryParameterPolicyItemIfExistsEnum = "APPEND"
SetQueryParameterPolicyItemIfExistsSkip SetQueryParameterPolicyItemIfExistsEnum = "SKIP"
)
func GetMappingSetQueryParameterPolicyItemIfExistsEnum(val string) (SetQueryParameterPolicyItemIfExistsEnum, bool)
GetMappingSetQueryParameterPolicyItemIfExistsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSetQueryParameterPolicyItemIfExistsEnumValues() []SetQueryParameterPolicyItemIfExistsEnum
GetSetQueryParameterPolicyItemIfExistsEnumValues Enumerates the set of values for SetQueryParameterPolicyItemIfExistsEnum
SimpleLookupPolicy Provides ability to vary the cache key using context expressions.
type SimpleLookupPolicy struct {
// Whether this policy is currently enabled.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your
// cache key additions to get the level of isolation across authenticated requests that you require.
// When false, any request with an Authorization header will not be stored in the Response Cache.
// If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check.
IsPrivateCachingEnabled *bool `mandatory:"false" json:"isPrivateCachingEnabled"`
// A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within
// ${} delimiters. Only the request context is available.
CacheKeyAdditions []string `mandatory:"false" json:"cacheKeyAdditions"`
}
func (m SimpleLookupPolicy) GetIsEnabled() *bool
GetIsEnabled returns IsEnabled
func (m SimpleLookupPolicy) GetIsPrivateCachingEnabled() *bool
GetIsPrivateCachingEnabled returns IsPrivateCachingEnabled
func (m SimpleLookupPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SimpleLookupPolicy) String() string
func (m SimpleLookupPolicy) ValidateEnumValue() (bool, error)
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
SingleSelectionSourcePolicy The single context variable in an incoming request to match against specified selection keys when dynamically routing and dynamically authenticating requests.
type SingleSelectionSourcePolicy struct {
// String describing the context variable used as selector.
Selector *string `mandatory:"true" json:"selector"`
}
func (m SingleSelectionSourcePolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SingleSelectionSourcePolicy) String() string
func (m SingleSelectionSourcePolicy) ValidateEnumValue() (bool, error)
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
SourceUriDetails Auth endpoint details.
type SourceUriDetails interface {
}
SourceUriDetailsTypeEnum Enum with underlying type: string
type SourceUriDetailsTypeEnum string
Set of constants representing the allowable values for SourceUriDetailsTypeEnum
const (
SourceUriDetailsTypeDiscoveryUri SourceUriDetailsTypeEnum = "DISCOVERY_URI"
SourceUriDetailsTypeValidationBlock SourceUriDetailsTypeEnum = "VALIDATION_BLOCK"
)
func GetMappingSourceUriDetailsTypeEnum(val string) (SourceUriDetailsTypeEnum, bool)
GetMappingSourceUriDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSourceUriDetailsTypeEnumValues() []SourceUriDetailsTypeEnum
GetSourceUriDetailsTypeEnumValues Enumerates the set of values for SourceUriDetailsTypeEnum
StaticPublicKey A static public key which is used to verify the JWT signature.
type StaticPublicKey interface {
// A unique key ID. This key will be used to verify the signature of a
// JWT with matching "kid".
GetKid() *string
}
StaticPublicKeyFormatEnum Enum with underlying type: string
type StaticPublicKeyFormatEnum string
Set of constants representing the allowable values for StaticPublicKeyFormatEnum
const (
StaticPublicKeyFormatJsonWebKey StaticPublicKeyFormatEnum = "JSON_WEB_KEY"
StaticPublicKeyFormatPem StaticPublicKeyFormatEnum = "PEM"
)
func GetMappingStaticPublicKeyFormatEnum(val string) (StaticPublicKeyFormatEnum, bool)
GetMappingStaticPublicKeyFormatEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStaticPublicKeyFormatEnumValues() []StaticPublicKeyFormatEnum
GetStaticPublicKeyFormatEnumValues Enumerates the set of values for StaticPublicKeyFormatEnum
StaticPublicKeySet A set of static public keys that will be used to verify the JWT signature.
type StaticPublicKeySet struct {
// The set of static public keys.
Keys []StaticPublicKey `mandatory:"false" json:"keys"`
}
func (m StaticPublicKeySet) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StaticPublicKeySet) String() string
func (m *StaticPublicKeySet) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m StaticPublicKeySet) ValidateEnumValue() (bool, error)
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
StockResponseBackend Send the request to a mock backend.
type StockResponseBackend struct {
// The status code of the stock response from the mock backend.
Status *int `mandatory:"true" json:"status"`
// The body of the stock response from the mock backend.
Body *string `mandatory:"false" json:"body"`
// The headers of the stock response from the mock backend.
Headers []HeaderFieldSpecification `mandatory:"false" json:"headers"`
}
func (m StockResponseBackend) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StockResponseBackend) String() string
func (m StockResponseBackend) ValidateEnumValue() (bool, error)
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
Subscriber A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.
type Subscriber struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The clients belonging to this subscriber.
Clients []Client `mandatory:"true" json:"clients"`
// An array of OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)s of usage
// plan resources.
UsagePlans []string `mandatory:"true" json:"usagePlans"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the subscriber.
LifecycleState SubscriberLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Subscriber) String() string
func (m Subscriber) ValidateEnumValue() (bool, error)
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
SubscriberCollection Collection of subscriber summaries.
type SubscriberCollection struct {
// Subscriber summaries.
Items []SubscriberSummary `mandatory:"true" json:"items"`
}
func (m SubscriberCollection) String() string
func (m SubscriberCollection) ValidateEnumValue() (bool, error)
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
SubscriberLifecycleStateEnum Enum with underlying type: string
type SubscriberLifecycleStateEnum string
Set of constants representing the allowable values for SubscriberLifecycleStateEnum
const (
SubscriberLifecycleStateCreating SubscriberLifecycleStateEnum = "CREATING"
SubscriberLifecycleStateActive SubscriberLifecycleStateEnum = "ACTIVE"
SubscriberLifecycleStateUpdating SubscriberLifecycleStateEnum = "UPDATING"
SubscriberLifecycleStateDeleting SubscriberLifecycleStateEnum = "DELETING"
SubscriberLifecycleStateDeleted SubscriberLifecycleStateEnum = "DELETED"
SubscriberLifecycleStateFailed SubscriberLifecycleStateEnum = "FAILED"
)
func GetMappingSubscriberLifecycleStateEnum(val string) (SubscriberLifecycleStateEnum, bool)
GetMappingSubscriberLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSubscriberLifecycleStateEnumValues() []SubscriberLifecycleStateEnum
GetSubscriberLifecycleStateEnumValues Enumerates the set of values for SubscriberLifecycleStateEnum
SubscriberSummary A summary of a subscriber.
type SubscriberSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The clients belonging to this subscriber.
Clients []ClientSummary `mandatory:"true" json:"clients"`
// An array of OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)s of usage
// plan resources.
UsagePlans []string `mandatory:"true" json:"usagePlans"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the subscriber.
LifecycleState SubscriberLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a
// resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m SubscriberSummary) String() string
func (m SubscriberSummary) ValidateEnumValue() (bool, error)
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
SubscribersClient a client for Subscribers
type SubscribersClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewSubscribersClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscribersClient, err error)
NewSubscribersClientWithConfigurationProvider Creates a new default Subscribers client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSubscribersClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscribersClient, err error)
NewSubscribersClientWithOboToken Creates a new default Subscribers client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client SubscribersClient) ChangeSubscriberCompartment(ctx context.Context, request ChangeSubscriberCompartmentRequest) (response ChangeSubscriberCompartmentResponse, err error)
ChangeSubscriberCompartment Changes the subscriber compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeSubscriberCompartment.go.html to see an example of how to use ChangeSubscriberCompartment API.
func (client *SubscribersClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SubscribersClient) CreateSubscriber(ctx context.Context, request CreateSubscriberRequest) (response CreateSubscriberResponse, err error)
CreateSubscriber Creates a new subscriber.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateSubscriber.go.html to see an example of how to use CreateSubscriber API. A default retry strategy applies to this operation CreateSubscriber()
func (client SubscribersClient) DeleteSubscriber(ctx context.Context, request DeleteSubscriberRequest) (response DeleteSubscriberResponse, err error)
DeleteSubscriber Deletes the subscriber with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteSubscriber.go.html to see an example of how to use DeleteSubscriber API.
func (client SubscribersClient) GetSubscriber(ctx context.Context, request GetSubscriberRequest) (response GetSubscriberResponse, err error)
GetSubscriber Gets a subscriber by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetSubscriber.go.html to see an example of how to use GetSubscriber API. A default retry strategy applies to this operation GetSubscriber()
func (client SubscribersClient) ListSubscribers(ctx context.Context, request ListSubscribersRequest) (response ListSubscribersResponse, err error)
ListSubscribers Returns a list of subscribers.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListSubscribers.go.html to see an example of how to use ListSubscribers API. A default retry strategy applies to this operation ListSubscribers()
func (client *SubscribersClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client SubscribersClient) UpdateSubscriber(ctx context.Context, request UpdateSubscriberRequest) (response UpdateSubscriberResponse, err error)
UpdateSubscriber Updates the subscriber with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateSubscriber.go.html to see an example of how to use UpdateSubscriber API.
TokenAuthenticationPolicy Validate a token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.
type TokenAuthenticationPolicy struct {
ValidationPolicy TokenAuthenticationValidationPolicy `mandatory:"true" json:"validationPolicy"`
// Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS
// route authorization.
IsAnonymousAccessAllowed *bool `mandatory:"false" json:"isAnonymousAccessAllowed"`
// The name of the header containing the authentication token.
TokenHeader *string `mandatory:"false" json:"tokenHeader"`
// The name of the query parameter containing the authentication token.
TokenQueryParam *string `mandatory:"false" json:"tokenQueryParam"`
// The authentication scheme that is to be used when authenticating
// the token. This must to be provided if "tokenHeader" is specified.
TokenAuthScheme *string `mandatory:"false" json:"tokenAuthScheme"`
// The maximum expected time difference between the system clocks
// of the token issuer and the API Gateway.
MaxClockSkewInSeconds *float32 `mandatory:"false" json:"maxClockSkewInSeconds"`
ValidationFailurePolicy ValidationFailurePolicy `mandatory:"false" json:"validationFailurePolicy"`
}
func (m TokenAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool
GetIsAnonymousAccessAllowed returns IsAnonymousAccessAllowed
func (m TokenAuthenticationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TokenAuthenticationPolicy) String() string
func (m *TokenAuthenticationPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TokenAuthenticationPolicy) ValidateEnumValue() (bool, error)
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
TokenAuthenticationRemoteDiscoveryValidationPolicy Instrospect Url based validation retrieved at run-time from a remote location to verify the provided token.
type TokenAuthenticationRemoteDiscoveryValidationPolicy struct {
ClientDetails ClientAppDetails `mandatory:"true" json:"clientDetails"`
SourceUriDetails SourceUriDetails `mandatory:"true" json:"sourceUriDetails"`
AdditionalValidationPolicy *AdditionalValidationPolicy `mandatory:"false" json:"additionalValidationPolicy"`
// Defines whether or not to uphold SSL verification.
IsSslVerifyDisabled *bool `mandatory:"false" json:"isSslVerifyDisabled"`
// The duration for which the introspect URL response should be cached before it is
// fetched again.
MaxCacheDurationInHours *int `mandatory:"false" json:"maxCacheDurationInHours"`
}
func (m TokenAuthenticationRemoteDiscoveryValidationPolicy) GetAdditionalValidationPolicy() *AdditionalValidationPolicy
GetAdditionalValidationPolicy returns AdditionalValidationPolicy
func (m TokenAuthenticationRemoteDiscoveryValidationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TokenAuthenticationRemoteDiscoveryValidationPolicy) String() string
func (m *TokenAuthenticationRemoteDiscoveryValidationPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TokenAuthenticationRemoteDiscoveryValidationPolicy) ValidateEnumValue() (bool, error)
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
TokenAuthenticationRemoteJwksValidationPolicy A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. The set should only contain JWK-formatted keys.
type TokenAuthenticationRemoteJwksValidationPolicy struct {
// The uri from which to retrieve the key. It must be accessible
// without authentication.
Uri *string `mandatory:"true" json:"uri"`
AdditionalValidationPolicy *AdditionalValidationPolicy `mandatory:"false" json:"additionalValidationPolicy"`
// Defines whether or not to uphold SSL verification.
IsSslVerifyDisabled *bool `mandatory:"false" json:"isSslVerifyDisabled"`
// The duration for which the JWKS should be cached before it is
// fetched again.
MaxCacheDurationInHours *int `mandatory:"false" json:"maxCacheDurationInHours"`
}
func (m TokenAuthenticationRemoteJwksValidationPolicy) GetAdditionalValidationPolicy() *AdditionalValidationPolicy
GetAdditionalValidationPolicy returns AdditionalValidationPolicy
func (m TokenAuthenticationRemoteJwksValidationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TokenAuthenticationRemoteJwksValidationPolicy) String() string
func (m TokenAuthenticationRemoteJwksValidationPolicy) ValidateEnumValue() (bool, error)
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
TokenAuthenticationStaticKeysValidationPolicy A set of static public keys that will be used to verify the JWT signature.
type TokenAuthenticationStaticKeysValidationPolicy struct {
AdditionalValidationPolicy *AdditionalValidationPolicy `mandatory:"false" json:"additionalValidationPolicy"`
// The set of static public keys.
Keys []StaticPublicKey `mandatory:"false" json:"keys"`
}
func (m TokenAuthenticationStaticKeysValidationPolicy) GetAdditionalValidationPolicy() *AdditionalValidationPolicy
GetAdditionalValidationPolicy returns AdditionalValidationPolicy
func (m TokenAuthenticationStaticKeysValidationPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TokenAuthenticationStaticKeysValidationPolicy) String() string
func (m *TokenAuthenticationStaticKeysValidationPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TokenAuthenticationStaticKeysValidationPolicy) ValidateEnumValue() (bool, error)
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
TokenAuthenticationValidationPolicy Authentication Policies for the Token Authentication types.
type TokenAuthenticationValidationPolicy interface {
GetAdditionalValidationPolicy() *AdditionalValidationPolicy
}
TokenAuthenticationValidationPolicyTypeEnum Enum with underlying type: string
type TokenAuthenticationValidationPolicyTypeEnum string
Set of constants representing the allowable values for TokenAuthenticationValidationPolicyTypeEnum
const (
TokenAuthenticationValidationPolicyTypeStaticKeys TokenAuthenticationValidationPolicyTypeEnum = "STATIC_KEYS"
TokenAuthenticationValidationPolicyTypeRemoteJwks TokenAuthenticationValidationPolicyTypeEnum = "REMOTE_JWKS"
TokenAuthenticationValidationPolicyTypeRemoteDiscovery TokenAuthenticationValidationPolicyTypeEnum = "REMOTE_DISCOVERY"
)
func GetMappingTokenAuthenticationValidationPolicyTypeEnum(val string) (TokenAuthenticationValidationPolicyTypeEnum, bool)
GetMappingTokenAuthenticationValidationPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTokenAuthenticationValidationPolicyTypeEnumValues() []TokenAuthenticationValidationPolicyTypeEnum
GetTokenAuthenticationValidationPolicyTypeEnumValues Enumerates the set of values for TokenAuthenticationValidationPolicyTypeEnum
UpdateApiDetails The information to be updated.
type UpdateApiDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// API Specification content in json or yaml format
Content *string `mandatory:"false" json:"content"`
}
func (m UpdateApiDetails) String() string
func (m UpdateApiDetails) ValidateEnumValue() (bool, error)
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
UpdateApiRequest wrapper for the UpdateApi operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateApi.go.html to see an example of how to use UpdateApiRequest.
type UpdateApiRequest struct {
// The ocid of the API.
ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`
// The information to be updated.
UpdateApiDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request UpdateApiRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateApiRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateApiRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateApiRequest) String() string
func (request UpdateApiRequest) ValidateEnumValue() (bool, error)
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
UpdateApiResponse wrapper for the UpdateApi operation
type UpdateApiResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response UpdateApiResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateApiResponse) String() string
UpdateCertificateDetails The information to be updated.
type UpdateCertificateDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateCertificateDetails) String() string
func (m UpdateCertificateDetails) ValidateEnumValue() (bool, error)
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
UpdateCertificateRequest wrapper for the UpdateCertificate operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateCertificate.go.html to see an example of how to use UpdateCertificateRequest.
type UpdateCertificateRequest struct {
// The ocid of the certificate.
CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`
// The information to be updated.
UpdateCertificateDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request UpdateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCertificateRequest) String() string
func (request UpdateCertificateRequest) ValidateEnumValue() (bool, error)
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
UpdateCertificateResponse wrapper for the UpdateCertificate operation
type UpdateCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response UpdateCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCertificateResponse) String() string
UpdateDeploymentDetails The information to be updated.
type UpdateDeploymentDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
Specification *ApiSpecification `mandatory:"false" json:"specification"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDeploymentDetails) String() string
func (m UpdateDeploymentDetails) ValidateEnumValue() (bool, error)
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
UpdateDeploymentRequest wrapper for the UpdateDeployment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateDeployment.go.html to see an example of how to use UpdateDeploymentRequest.
type UpdateDeploymentRequest struct {
// The ocid of the deployment.
DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`
// The information to be updated.
UpdateDeploymentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request UpdateDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDeploymentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDeploymentRequest) String() string
func (request UpdateDeploymentRequest) ValidateEnumValue() (bool, error)
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
UpdateDeploymentResponse wrapper for the UpdateDeployment operation
type UpdateDeploymentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response UpdateDeploymentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDeploymentResponse) String() string
UpdateGatewayDetails The information to be updated.
type UpdateGatewayDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// An array of Network Security Groups OCIDs associated with this API Gateway.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
CertificateId *string `mandatory:"false" json:"certificateId"`
ResponseCacheDetails ResponseCacheDetails `mandatory:"false" json:"responseCacheDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// An array of CA bundles that should be used on the Gateway for TLS validation.
CaBundles []CaBundle `mandatory:"false" json:"caBundles"`
}
func (m UpdateGatewayDetails) String() string
func (m *UpdateGatewayDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateGatewayDetails) ValidateEnumValue() (bool, error)
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
UpdateGatewayRequest wrapper for the UpdateGateway operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateGateway.go.html to see an example of how to use UpdateGatewayRequest.
type UpdateGatewayRequest struct {
// The ocid of the gateway.
GatewayId *string `mandatory:"true" contributesTo:"path" name:"gatewayId"`
// The information to be updated.
UpdateGatewayDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request UpdateGatewayRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGatewayRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGatewayRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGatewayRequest) String() string
func (request UpdateGatewayRequest) ValidateEnumValue() (bool, error)
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
UpdateGatewayResponse wrapper for the UpdateGateway operation
type UpdateGatewayResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response UpdateGatewayResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGatewayResponse) String() string
UpdateSdkDetails The information to be updated.
type UpdateSdkDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateSdkDetails) String() string
func (m UpdateSdkDetails) ValidateEnumValue() (bool, error)
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
UpdateSdkRequest wrapper for the UpdateSdk operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateSdk.go.html to see an example of how to use UpdateSdkRequest.
type UpdateSdkRequest struct {
// The ocid of the SDK.
SdkId *string `mandatory:"true" contributesTo:"path" name:"sdkId"`
// The information to be updated.
UpdateSdkDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request UpdateSdkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSdkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSdkRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSdkRequest) String() string
func (request UpdateSdkRequest) ValidateEnumValue() (bool, error)
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
UpdateSdkResponse wrapper for the UpdateSdk operation
type UpdateSdkResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
}
func (response UpdateSdkResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSdkResponse) String() string
UpdateSubscriberDetails The information to be updated.
type UpdateSubscriberDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// The clients belonging to the subscriber.
Clients []Client `mandatory:"false" json:"clients"`
// An array of OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)s of usage
// plan resources.
UsagePlans []string `mandatory:"false" json:"usagePlans"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateSubscriberDetails) String() string
func (m UpdateSubscriberDetails) ValidateEnumValue() (bool, error)
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
UpdateSubscriberRequest wrapper for the UpdateSubscriber operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateSubscriber.go.html to see an example of how to use UpdateSubscriberRequest.
type UpdateSubscriberRequest struct {
// The ocid of the subscriber.
SubscriberId *string `mandatory:"true" contributesTo:"path" name:"subscriberId"`
// The information to be updated.
UpdateSubscriberDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request UpdateSubscriberRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSubscriberRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSubscriberRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSubscriberRequest) String() string
func (request UpdateSubscriberRequest) ValidateEnumValue() (bool, error)
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
UpdateSubscriberResponse wrapper for the UpdateSubscriber operation
type UpdateSubscriberResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response UpdateSubscriberResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSubscriberResponse) String() string
UpdateUsagePlanDetails The information to be updated.
type UpdateUsagePlanDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// A collection of entitlements to update the current usage plan with.
Entitlements []Entitlement `mandatory:"false" json:"entitlements"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateUsagePlanDetails) String() string
func (m UpdateUsagePlanDetails) ValidateEnumValue() (bool, error)
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
UpdateUsagePlanRequest wrapper for the UpdateUsagePlan operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateUsagePlan.go.html to see an example of how to use UpdateUsagePlanRequest.
type UpdateUsagePlanRequest struct {
// The ocid of the usage plan.
UsagePlanId *string `mandatory:"true" contributesTo:"path" name:"usagePlanId"`
// The information to be updated.
UpdateUsagePlanDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request id for tracing.
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
}
func (request UpdateUsagePlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateUsagePlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateUsagePlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateUsagePlanRequest) String() string
func (request UpdateUsagePlanRequest) ValidateEnumValue() (bool, error)
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
UpdateUsagePlanResponse wrapper for the UpdateUsagePlan operation
type UpdateUsagePlanResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID of the work request. Use
// GetWorkRequest with
// this id to track the status
// of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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"`
}
func (response UpdateUsagePlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateUsagePlanResponse) String() string
UsagePlan A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.
type UsagePlan struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a usage plan
// resource.
Id *string `mandatory:"true" json:"id"`
// A collection of entitlements currently assigned to the usage plan.
Entitlements []Entitlement `mandatory:"true" json:"entitlements"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the usage plan.
LifecycleState UsagePlanLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UsagePlan) String() string
func (m UsagePlan) ValidateEnumValue() (bool, error)
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
UsagePlanCollection Collection of usage plan summaries.
type UsagePlanCollection struct {
// Usage plan summaries.
Items []UsagePlanSummary `mandatory:"true" json:"items"`
}
func (m UsagePlanCollection) String() string
func (m UsagePlanCollection) ValidateEnumValue() (bool, error)
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
UsagePlanLifecycleStateEnum Enum with underlying type: string
type UsagePlanLifecycleStateEnum string
Set of constants representing the allowable values for UsagePlanLifecycleStateEnum
const (
UsagePlanLifecycleStateCreating UsagePlanLifecycleStateEnum = "CREATING"
UsagePlanLifecycleStateActive UsagePlanLifecycleStateEnum = "ACTIVE"
UsagePlanLifecycleStateUpdating UsagePlanLifecycleStateEnum = "UPDATING"
UsagePlanLifecycleStateDeleting UsagePlanLifecycleStateEnum = "DELETING"
UsagePlanLifecycleStateDeleted UsagePlanLifecycleStateEnum = "DELETED"
UsagePlanLifecycleStateFailed UsagePlanLifecycleStateEnum = "FAILED"
)
func GetMappingUsagePlanLifecycleStateEnum(val string) (UsagePlanLifecycleStateEnum, bool)
GetMappingUsagePlanLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUsagePlanLifecycleStateEnumValues() []UsagePlanLifecycleStateEnum
GetUsagePlanLifecycleStateEnumValues Enumerates the set of values for UsagePlanLifecycleStateEnum
UsagePlanSummary A summary of the usage plan.
type UsagePlanSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a usage plan
// resource.
Id *string `mandatory:"true" json:"id"`
// A collection of entitlements applied by the usage plan.
Entitlements []EntitlementSummary `mandatory:"true" json:"entitlements"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the usage plan.
LifecycleState UsagePlanLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
// Example: `My new resource`
DisplayName *string `mandatory:"false" json:"displayName"`
// A message describing the current state in more detail.
// For example, can be used to provide actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Free-form tags for this resource. Each tag is a simple key-value pair
// with no predefined name, type, or namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see
// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UsagePlanSummary) String() string
func (m UsagePlanSummary) ValidateEnumValue() (bool, error)
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
UsagePlansClient a client for UsagePlans
type UsagePlansClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewUsagePlansClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client UsagePlansClient, err error)
NewUsagePlansClientWithConfigurationProvider Creates a new default UsagePlans client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewUsagePlansClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client UsagePlansClient, err error)
NewUsagePlansClientWithOboToken Creates a new default UsagePlans client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client UsagePlansClient) ChangeUsagePlanCompartment(ctx context.Context, request ChangeUsagePlanCompartmentRequest) (response ChangeUsagePlanCompartmentResponse, err error)
ChangeUsagePlanCompartment Changes the usage plan compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ChangeUsagePlanCompartment.go.html to see an example of how to use ChangeUsagePlanCompartment API.
func (client *UsagePlansClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client UsagePlansClient) CreateUsagePlan(ctx context.Context, request CreateUsagePlanRequest) (response CreateUsagePlanResponse, err error)
CreateUsagePlan Creates a new usage plan.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CreateUsagePlan.go.html to see an example of how to use CreateUsagePlan API. A default retry strategy applies to this operation CreateUsagePlan()
func (client UsagePlansClient) DeleteUsagePlan(ctx context.Context, request DeleteUsagePlanRequest) (response DeleteUsagePlanResponse, err error)
DeleteUsagePlan Deletes the usage plan with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/DeleteUsagePlan.go.html to see an example of how to use DeleteUsagePlan API.
func (client UsagePlansClient) GetUsagePlan(ctx context.Context, request GetUsagePlanRequest) (response GetUsagePlanResponse, err error)
GetUsagePlan Gets a usage plan by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetUsagePlan.go.html to see an example of how to use GetUsagePlan API. A default retry strategy applies to this operation GetUsagePlan()
func (client UsagePlansClient) ListUsagePlans(ctx context.Context, request ListUsagePlansRequest) (response ListUsagePlansResponse, err error)
ListUsagePlans Returns a list of usage plans.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListUsagePlans.go.html to see an example of how to use ListUsagePlans API. A default retry strategy applies to this operation ListUsagePlans()
func (client *UsagePlansClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client UsagePlansClient) UpdateUsagePlan(ctx context.Context, request UpdateUsagePlanRequest) (response UpdateUsagePlanResponse, err error)
UpdateUsagePlan Updates the usage plan with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/UpdateUsagePlan.go.html to see an example of how to use UpdateUsagePlan API.
UsagePlansPolicy Usage plan policies for this deployment
type UsagePlansPolicy struct {
// A list of context variables specifying where API tokens may be located in a request.
// Example locations:
// - "request.headers[token]"
// - "request.query[token]"
// - "request.auth[Token]"
// - "request.path[TOKEN]"
TokenLocations []string `mandatory:"true" json:"tokenLocations"`
}
func (m UsagePlansPolicy) String() string
func (m UsagePlansPolicy) ValidateEnumValue() (bool, error)
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
ValidationBlockClientAppDetails Client App Credentials to be used from validation block.
type ValidationBlockClientAppDetails struct {
}
func (m ValidationBlockClientAppDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValidationBlockClientAppDetails) String() string
func (m ValidationBlockClientAppDetails) ValidateEnumValue() (bool, error)
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
ValidationBlockSourceUriDetails Source Uri information to be used from validation block.
type ValidationBlockSourceUriDetails struct {
}
func (m ValidationBlockSourceUriDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValidationBlockSourceUriDetails) String() string
func (m ValidationBlockSourceUriDetails) ValidateEnumValue() (bool, error)
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
ValidationFailurePolicy Policy for defining behaviour on validation failure.
type ValidationFailurePolicy interface {
}
ValidationFailurePolicyTypeEnum Enum with underlying type: string
type ValidationFailurePolicyTypeEnum string
Set of constants representing the allowable values for ValidationFailurePolicyTypeEnum
const (
ValidationFailurePolicyTypeModifyResponse ValidationFailurePolicyTypeEnum = "MODIFY_RESPONSE"
ValidationFailurePolicyTypeOauth2 ValidationFailurePolicyTypeEnum = "OAUTH2"
)
func GetMappingValidationFailurePolicyTypeEnum(val string) (ValidationFailurePolicyTypeEnum, bool)
GetMappingValidationFailurePolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetValidationFailurePolicyTypeEnumValues() []ValidationFailurePolicyTypeEnum
GetValidationFailurePolicyTypeEnumValues Enumerates the set of values for ValidationFailurePolicyTypeEnum
ValidationRequestPolicy Top-level validation policy mixin (not directly used).
type ValidationRequestPolicy struct {
// Validation behavior mode.
// In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response
// and not sent to the backend.
// In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request
// will follow the normal path.
// `DISABLED` type turns the validation off.
ValidationMode ValidationRequestPolicyValidationModeEnum `mandatory:"false" json:"validationMode,omitempty"`
}
func (m ValidationRequestPolicy) String() string
func (m ValidationRequestPolicy) ValidateEnumValue() (bool, error)
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
ValidationRequestPolicyValidationModeEnum Enum with underlying type: string
type ValidationRequestPolicyValidationModeEnum string
Set of constants representing the allowable values for ValidationRequestPolicyValidationModeEnum
const (
ValidationRequestPolicyValidationModeEnforcing ValidationRequestPolicyValidationModeEnum = "ENFORCING"
ValidationRequestPolicyValidationModePermissive ValidationRequestPolicyValidationModeEnum = "PERMISSIVE"
ValidationRequestPolicyValidationModeDisabled ValidationRequestPolicyValidationModeEnum = "DISABLED"
)
func GetMappingValidationRequestPolicyValidationModeEnum(val string) (ValidationRequestPolicyValidationModeEnum, bool)
GetMappingValidationRequestPolicyValidationModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetValidationRequestPolicyValidationModeEnumValues() []ValidationRequestPolicyValidationModeEnum
GetValidationRequestPolicyValidationModeEnumValues Enumerates the set of values for ValidationRequestPolicyValidationModeEnum
WildcardSelectionKey When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a selection key containing a wildcard is used if the context variable in an incoming request matches that key.
type WildcardSelectionKey struct {
// Name assigned to the branch.
Name *string `mandatory:"true" json:"name"`
// A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are '*' (zero or more characters) and '+' (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string.
Expression *string `mandatory:"true" json:"expression"`
// Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.
IsDefault *bool `mandatory:"false" json:"isDefault"`
}
func (m WildcardSelectionKey) GetIsDefault() *bool
GetIsDefault returns IsDefault
func (m WildcardSelectionKey) GetName() *string
GetName returns Name
func (m WildcardSelectionKey) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m WildcardSelectionKey) String() string
func (m WildcardSelectionKey) ValidateEnumValue() (bool, error)
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
WorkRequest A description of the work request status.
type WorkRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The type of the work request.
OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status WorkRequestStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
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
WorkRequestCollection Collection of work request summaries.
type WorkRequestCollection struct {
// Work request summaries.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestCollection) String() string
func (m WorkRequestCollection) ValidateEnumValue() (bool, error)
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
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. See
// <a href="/Content/API/References/apierrors.htm">API Errors</a>.
Code *string `mandatory:"true" json:"code"`
// A human-readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
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
WorkRequestErrorCollection Collection of work request errors.
type WorkRequestErrorCollection struct {
// Work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
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
WorkRequestLog A log message from the execution of a work request.
type WorkRequestLog struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLog) String() string
func (m WorkRequestLog) ValidateEnumValue() (bool, error)
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
WorkRequestLogCollection Collection of work request logs.
type WorkRequestLogCollection struct {
// Work request logs.
Items []WorkRequestLog `mandatory:"true" json:"items"`
}
func (m WorkRequestLogCollection) String() string
func (m WorkRequestLogCollection) ValidateEnumValue() (bool, error)
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
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const (
WorkRequestOperationTypeCreateGateway WorkRequestOperationTypeEnum = "CREATE_GATEWAY"
WorkRequestOperationTypeUpdateGateway WorkRequestOperationTypeEnum = "UPDATE_GATEWAY"
WorkRequestOperationTypeDeleteGateway WorkRequestOperationTypeEnum = "DELETE_GATEWAY"
WorkRequestOperationTypeCreateDeployment WorkRequestOperationTypeEnum = "CREATE_DEPLOYMENT"
WorkRequestOperationTypeUpdateDeployment WorkRequestOperationTypeEnum = "UPDATE_DEPLOYMENT"
WorkRequestOperationTypeDeleteDeployment WorkRequestOperationTypeEnum = "DELETE_DEPLOYMENT"
WorkRequestOperationTypeCreateCertificate WorkRequestOperationTypeEnum = "CREATE_CERTIFICATE"
WorkRequestOperationTypeUpdateCertificate WorkRequestOperationTypeEnum = "UPDATE_CERTIFICATE"
WorkRequestOperationTypeDeleteCertificate WorkRequestOperationTypeEnum = "DELETE_CERTIFICATE"
WorkRequestOperationTypeCreateApi WorkRequestOperationTypeEnum = "CREATE_API"
WorkRequestOperationTypeUpdateApi WorkRequestOperationTypeEnum = "UPDATE_API"
WorkRequestOperationTypeDeleteApi WorkRequestOperationTypeEnum = "DELETE_API"
WorkRequestOperationTypeValidateApi WorkRequestOperationTypeEnum = "VALIDATE_API"
WorkRequestOperationTypeCreateSdk WorkRequestOperationTypeEnum = "CREATE_SDK"
WorkRequestOperationTypeDeleteSdk WorkRequestOperationTypeEnum = "DELETE_SDK"
WorkRequestOperationTypeCreateUsagePlan WorkRequestOperationTypeEnum = "CREATE_USAGE_PLAN"
WorkRequestOperationTypeUpdateUsagePlan WorkRequestOperationTypeEnum = "UPDATE_USAGE_PLAN"
WorkRequestOperationTypeDeleteUsagePlan WorkRequestOperationTypeEnum = "DELETE_USAGE_PLAN"
WorkRequestOperationTypeCreateSubscriber WorkRequestOperationTypeEnum = "CREATE_SUBSCRIBER"
WorkRequestOperationTypeUpdateSubscriber WorkRequestOperationTypeEnum = "UPDATE_SUBSCRIBER"
WorkRequestOperationTypeDeleteSubscriber WorkRequestOperationTypeEnum = "DELETE_SUBSCRIBER"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource; at which point, it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path on which the user can perform a GET operation to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
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
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED"
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
WorkRequestResourceActionTypeFailed WorkRequestResourceActionTypeEnum = "FAILED"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const (
WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED"
WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary A summary of the work request.
type WorkRequestSummary struct {
// The type of the work request.
OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status WorkRequestStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
WorkRequestId *string `mandatory:"true" json:"workRequestId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
// resource is created.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
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
WorkRequestsClient a client for WorkRequests
type WorkRequestsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewWorkRequestsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestsClient, err error)
NewWorkRequestsClientWithConfigurationProvider Creates a new default WorkRequests client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewWorkRequestsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestsClient, err error)
NewWorkRequestsClientWithOboToken Creates a new default WorkRequests client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client WorkRequestsClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels the work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API.
func (client *WorkRequestsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client WorkRequestsClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client WorkRequestsClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for a given work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client WorkRequestsClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for a given work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client WorkRequestsClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/apigateway/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *WorkRequestsClient) SetRegion(region string)
SetRegion overrides the region of this client.