func GetListServiceEnvironmentsSortByEnumStringValues() []string
GetListServiceEnvironmentsSortByEnumStringValues Enumerates the set of values in String for ListServiceEnvironmentsSortByEnum
func GetListServiceEnvironmentsSortOrderEnumStringValues() []string
GetListServiceEnvironmentsSortOrderEnumStringValues Enumerates the set of values in String for ListServiceEnvironmentsSortOrderEnum
func GetServiceEntitlementRegistrationStatusEnumStringValues() []string
GetServiceEntitlementRegistrationStatusEnumStringValues Enumerates the set of values in String for ServiceEntitlementRegistrationStatusEnum
func GetServiceEnvironmentEndPointOverviewEnvironmentTypeEnumStringValues() []string
GetServiceEnvironmentEndPointOverviewEnvironmentTypeEnumStringValues Enumerates the set of values in String for ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum
ErrorEntity The model for the error entity.
type ErrorEntity struct {
// A short error code that defines the error.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
}
func (m ErrorEntity) String() string
func (m ErrorEntity) 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
GetServiceEnvironmentRequest wrapper for the GetServiceEnvironment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/servicemanagerproxy/GetServiceEnvironment.go.html to see an example of how to use GetServiceEnvironmentRequest.
type GetServiceEnvironmentRequest struct {
// The unique identifier associated with the service environment.
// **Note:** Not an OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
ServiceEnvironmentId *string `mandatory:"true" contributesTo:"path" name:"serviceEnvironmentId"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) for the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 GetServiceEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetServiceEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetServiceEnvironmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetServiceEnvironmentRequest) String() string
func (request GetServiceEnvironmentRequest) 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
GetServiceEnvironmentResponse wrapper for the GetServiceEnvironment operation
type GetServiceEnvironmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The ServiceEnvironment instance
ServiceEnvironment `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetServiceEnvironmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetServiceEnvironmentResponse) String() string
ListServiceEnvironmentsRequest wrapper for the ListServiceEnvironments operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/servicemanagerproxy/ListServiceEnvironments.go.html to see an example of how to use ListServiceEnvironmentsRequest.
type ListServiceEnvironmentsRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) for the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The unique identifier associated with the service environment.
// **Note:** Not an OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
ServiceEnvironmentId *string `mandatory:"false" contributesTo:"query" name:"serviceEnvironmentId"`
// The environment's service definition type.
// For example, "RGBUOROMS" is the service definition type for "Oracle Retail Order Management Cloud Service".
ServiceEnvironmentType *string `mandatory:"false" contributesTo:"query" name:"serviceEnvironmentType"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by. Only one sort order may be provided. ID is default ordered as ascending.
SortBy ListServiceEnvironmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either `ASC` or `DESC`.
SortOrder ListServiceEnvironmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The display name of the resource.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// 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 ListServiceEnvironmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListServiceEnvironmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListServiceEnvironmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListServiceEnvironmentsRequest) String() string
func (request ListServiceEnvironmentsRequest) 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
ListServiceEnvironmentsResponse wrapper for the ListServiceEnvironments operation
type ListServiceEnvironmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ServiceEnvironmentCollection instances
ServiceEnvironmentCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListServiceEnvironmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListServiceEnvironmentsResponse) String() string
ListServiceEnvironmentsSortByEnum Enum with underlying type: string
type ListServiceEnvironmentsSortByEnum string
Set of constants representing the allowable values for ListServiceEnvironmentsSortByEnum
const (
ListServiceEnvironmentsSortById ListServiceEnvironmentsSortByEnum = "ID"
)
func GetListServiceEnvironmentsSortByEnumValues() []ListServiceEnvironmentsSortByEnum
GetListServiceEnvironmentsSortByEnumValues Enumerates the set of values for ListServiceEnvironmentsSortByEnum
func GetMappingListServiceEnvironmentsSortByEnum(val string) (ListServiceEnvironmentsSortByEnum, bool)
GetMappingListServiceEnvironmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListServiceEnvironmentsSortOrderEnum Enum with underlying type: string
type ListServiceEnvironmentsSortOrderEnum string
Set of constants representing the allowable values for ListServiceEnvironmentsSortOrderEnum
const (
ListServiceEnvironmentsSortOrderAsc ListServiceEnvironmentsSortOrderEnum = "ASC"
ListServiceEnvironmentsSortOrderDesc ListServiceEnvironmentsSortOrderEnum = "DESC"
)
func GetListServiceEnvironmentsSortOrderEnumValues() []ListServiceEnvironmentsSortOrderEnum
GetListServiceEnvironmentsSortOrderEnumValues Enumerates the set of values for ListServiceEnvironmentsSortOrderEnum
func GetMappingListServiceEnvironmentsSortOrderEnum(val string) (ListServiceEnvironmentsSortOrderEnum, bool)
GetMappingListServiceEnvironmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ServiceDefinition Details for a service definition.
type ServiceDefinition struct {
// The service definition type. For example, a service definition type "RGBUOROMS"
// would be for the service "Oracle Retail Order Management Cloud Service".
Type *string `mandatory:"true" json:"type"`
// Display name of the service. For example, "Oracle Retail Order Management Cloud Service".
DisplayName *string `mandatory:"true" json:"displayName"`
// Short display name of the service. For example, "Retail Order Management".
ShortDisplayName *string `mandatory:"true" json:"shortDisplayName"`
}
func (m ServiceDefinition) String() string
func (m ServiceDefinition) 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
ServiceEntitlementRegistrationStatusEnum Enum with underlying type: string
type ServiceEntitlementRegistrationStatusEnum string
Set of constants representing the allowable values for ServiceEntitlementRegistrationStatusEnum
const (
ServiceEntitlementRegistrationStatusInitialized ServiceEntitlementRegistrationStatusEnum = "INITIALIZED"
ServiceEntitlementRegistrationStatusBeginActivation ServiceEntitlementRegistrationStatusEnum = "BEGIN_ACTIVATION"
ServiceEntitlementRegistrationStatusActive ServiceEntitlementRegistrationStatusEnum = "ACTIVE"
ServiceEntitlementRegistrationStatusBeginSoftTermination ServiceEntitlementRegistrationStatusEnum = "BEGIN_SOFT_TERMINATION"
ServiceEntitlementRegistrationStatusSoftTerminated ServiceEntitlementRegistrationStatusEnum = "SOFT_TERMINATED"
ServiceEntitlementRegistrationStatusBeginTermination ServiceEntitlementRegistrationStatusEnum = "BEGIN_TERMINATION"
ServiceEntitlementRegistrationStatusCanceled ServiceEntitlementRegistrationStatusEnum = "CANCELED"
ServiceEntitlementRegistrationStatusTerminated ServiceEntitlementRegistrationStatusEnum = "TERMINATED"
ServiceEntitlementRegistrationStatusBeginDisabling ServiceEntitlementRegistrationStatusEnum = "BEGIN_DISABLING"
ServiceEntitlementRegistrationStatusBeginEnabling ServiceEntitlementRegistrationStatusEnum = "BEGIN_ENABLING"
ServiceEntitlementRegistrationStatusBeginMigration ServiceEntitlementRegistrationStatusEnum = "BEGIN_MIGRATION"
ServiceEntitlementRegistrationStatusDisabled ServiceEntitlementRegistrationStatusEnum = "DISABLED"
ServiceEntitlementRegistrationStatusBeginSuspension ServiceEntitlementRegistrationStatusEnum = "BEGIN_SUSPENSION"
ServiceEntitlementRegistrationStatusBeginResumption ServiceEntitlementRegistrationStatusEnum = "BEGIN_RESUMPTION"
ServiceEntitlementRegistrationStatusSuspended ServiceEntitlementRegistrationStatusEnum = "SUSPENDED"
ServiceEntitlementRegistrationStatusBeginLockRelocation ServiceEntitlementRegistrationStatusEnum = "BEGIN_LOCK_RELOCATION"
ServiceEntitlementRegistrationStatusLockedRelocation ServiceEntitlementRegistrationStatusEnum = "LOCKED_RELOCATION"
ServiceEntitlementRegistrationStatusBeginRelocation ServiceEntitlementRegistrationStatusEnum = "BEGIN_RELOCATION"
ServiceEntitlementRegistrationStatusRelocated ServiceEntitlementRegistrationStatusEnum = "RELOCATED"
ServiceEntitlementRegistrationStatusBeginUnlockRelocation ServiceEntitlementRegistrationStatusEnum = "BEGIN_UNLOCK_RELOCATION"
ServiceEntitlementRegistrationStatusUnlockedRelocation ServiceEntitlementRegistrationStatusEnum = "UNLOCKED_RELOCATION"
ServiceEntitlementRegistrationStatusFailedLockRelocation ServiceEntitlementRegistrationStatusEnum = "FAILED_LOCK_RELOCATION"
ServiceEntitlementRegistrationStatusFailedActivation ServiceEntitlementRegistrationStatusEnum = "FAILED_ACTIVATION"
ServiceEntitlementRegistrationStatusFailedMigration ServiceEntitlementRegistrationStatusEnum = "FAILED_MIGRATION"
ServiceEntitlementRegistrationStatusAccessDisabled ServiceEntitlementRegistrationStatusEnum = "ACCESS_DISABLED"
ServiceEntitlementRegistrationStatusBeginDisablingAccess ServiceEntitlementRegistrationStatusEnum = "BEGIN_DISABLING_ACCESS"
ServiceEntitlementRegistrationStatusBeginEnablingAccess ServiceEntitlementRegistrationStatusEnum = "BEGIN_ENABLING_ACCESS"
ServiceEntitlementRegistrationStatusTraUnknown ServiceEntitlementRegistrationStatusEnum = "TRA_UNKNOWN"
)
func GetMappingServiceEntitlementRegistrationStatusEnum(val string) (ServiceEntitlementRegistrationStatusEnum, bool)
GetMappingServiceEntitlementRegistrationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetServiceEntitlementRegistrationStatusEnumValues() []ServiceEntitlementRegistrationStatusEnum
GetServiceEntitlementRegistrationStatusEnumValues Enumerates the set of values for ServiceEntitlementRegistrationStatusEnum
ServiceEnvironment Detailed information about a service environment. **Note:** Service URL formats may vary from the provided example.
type ServiceEnvironment struct {
// Unqiue identifier for the entitlement related to the environment.
// **Note:** Not an OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
Id *string `mandatory:"true" json:"id"`
// The unique subscription ID associated with the service environment ID.
// **Note:** Not an OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// Status of the entitlement registration for the service.
Status ServiceEntitlementRegistrationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) for the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ServiceDefinition *ServiceDefinition `mandatory:"true" json:"serviceDefinition"`
// The URL for the console.
ConsoleUrl *string `mandatory:"false" json:"consoleUrl"`
// Array of service environment end points.
ServiceEnvironmentEndpoints []ServiceEnvironmentEndPointOverview `mandatory:"false" json:"serviceEnvironmentEndpoints"`
}
func (m ServiceEnvironment) String() string
func (m ServiceEnvironment) 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
ServiceEnvironmentCollection Collection of service environments. **Note:** Service URL formats may vary from the provided example.
type ServiceEnvironmentCollection struct {
// Collection of items.
Items []ServiceEnvironmentSummary `mandatory:"true" json:"items"`
}
func (m ServiceEnvironmentCollection) String() string
func (m ServiceEnvironmentCollection) 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
ServiceEnvironmentEndPointOverview An overview of service environment endpoints.
type ServiceEnvironmentEndPointOverview struct {
// Service environment endpoint type.
EnvironmentType ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum `mandatory:"true" json:"environmentType"`
// Service environment instance URL.
Url *string `mandatory:"true" json:"url"`
// Description of the environment link
Description *string `mandatory:"false" json:"description"`
}
func (m ServiceEnvironmentEndPointOverview) String() string
func (m ServiceEnvironmentEndPointOverview) 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
ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum Enum with underlying type: string
type ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum string
Set of constants representing the allowable values for ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum
const (
ServiceEnvironmentEndPointOverviewEnvironmentTypeInstanceUrlProd ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum = "INSTANCE_URL_PROD"
ServiceEnvironmentEndPointOverviewEnvironmentTypeInstanceUrlTest ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum = "INSTANCE_URL_TEST"
ServiceEnvironmentEndPointOverviewEnvironmentTypeInstanceUrlDev ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum = "INSTANCE_URL_DEV"
ServiceEnvironmentEndPointOverviewEnvironmentTypeOther ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum = "OTHER"
)
func GetMappingServiceEnvironmentEndPointOverviewEnvironmentTypeEnum(val string) (ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum, bool)
GetMappingServiceEnvironmentEndPointOverviewEnvironmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetServiceEnvironmentEndPointOverviewEnvironmentTypeEnumValues() []ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum
GetServiceEnvironmentEndPointOverviewEnvironmentTypeEnumValues Enumerates the set of values for ServiceEnvironmentEndPointOverviewEnvironmentTypeEnum
ServiceEnvironmentSummary Summary of service environment details.
type ServiceEnvironmentSummary struct {
// Unqiue identifier for the entitlement related to the environment.
// **Note:** Not an OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
Id *string `mandatory:"true" json:"id"`
// The unique subscription ID associated with the service environment ID.
// **Note:** Not an OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// Status of the entitlement registration for the service.
Status ServiceEntitlementRegistrationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) for the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ServiceDefinition *ServiceDefinition `mandatory:"true" json:"serviceDefinition"`
// The URL for the console.
ConsoleUrl *string `mandatory:"false" json:"consoleUrl"`
// Array of service environment end points.
ServiceEnvironmentEndpoints []ServiceEnvironmentEndPointOverview `mandatory:"false" json:"serviceEnvironmentEndpoints"`
// 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"`
// 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: `{"CostCenter": "42"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m ServiceEnvironmentSummary) String() string
func (m ServiceEnvironmentSummary) 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
ServiceManagerProxyClient a client for ServiceManagerProxy
type ServiceManagerProxyClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewServiceManagerProxyClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ServiceManagerProxyClient, err error)
NewServiceManagerProxyClientWithConfigurationProvider Creates a new default ServiceManagerProxy client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewServiceManagerProxyClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ServiceManagerProxyClient, err error)
NewServiceManagerProxyClientWithOboToken Creates a new default ServiceManagerProxy 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 *ServiceManagerProxyClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ServiceManagerProxyClient) GetServiceEnvironment(ctx context.Context, request GetServiceEnvironmentRequest) (response GetServiceEnvironmentResponse, err error)
GetServiceEnvironment Get the detailed information for a specific service environment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/servicemanagerproxy/GetServiceEnvironment.go.html to see an example of how to use GetServiceEnvironment API.
func (client ServiceManagerProxyClient) ListServiceEnvironments(ctx context.Context, request ListServiceEnvironmentsRequest) (response ListServiceEnvironmentsResponse, err error)
ListServiceEnvironments List the details of Software as a Service (SaaS) environments provisioned by Service Manager. Information includes the service instance endpoints and service definition details.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/servicemanagerproxy/ListServiceEnvironments.go.html to see an example of how to use ListServiceEnvironments API.
func (client *ServiceManagerProxyClient) SetRegion(region string)
SetRegion overrides the region of this client.