func GetFieldInfoFieldTypeEnumStringValues() []string
GetFieldInfoFieldTypeEnumStringValues Enumerates the set of values in String for FieldInfoFieldTypeEnum
FieldInfo Contains field schema information.
type FieldInfo struct {
// Field name
FieldName *string `mandatory:"true" json:"fieldName"`
// Field type -
// * `STRING`: A sequence of characters.
// * `NUMBER`: Numeric type which can be an integer or floating point.
// * `BOOLEAN`: Either true or false.
// * `ARRAY`: An ordered collection of values.
FieldType FieldInfoFieldTypeEnum `mandatory:"true" json:"fieldType"`
}
func (m FieldInfo) String() string
func (m FieldInfo) 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
FieldInfoFieldTypeEnum Enum with underlying type: string
type FieldInfoFieldTypeEnum string
Set of constants representing the allowable values for FieldInfoFieldTypeEnum
const (
FieldInfoFieldTypeString FieldInfoFieldTypeEnum = "STRING"
FieldInfoFieldTypeNumber FieldInfoFieldTypeEnum = "NUMBER"
FieldInfoFieldTypeBoolean FieldInfoFieldTypeEnum = "BOOLEAN"
FieldInfoFieldTypeArray FieldInfoFieldTypeEnum = "ARRAY"
)
func GetFieldInfoFieldTypeEnumValues() []FieldInfoFieldTypeEnum
GetFieldInfoFieldTypeEnumValues Enumerates the set of values for FieldInfoFieldTypeEnum
func GetMappingFieldInfoFieldTypeEnum(val string) (FieldInfoFieldTypeEnum, bool)
GetMappingFieldInfoFieldTypeEnum performs case Insensitive comparison on enum value and return the desired enum
LogSearchClient a client for LogSearch
type LogSearchClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewLogSearchClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client LogSearchClient, err error)
NewLogSearchClientWithConfigurationProvider Creates a new default LogSearch client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewLogSearchClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client LogSearchClient, err error)
NewLogSearchClientWithOboToken Creates a new default LogSearch 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 *LogSearchClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client LogSearchClient) SearchLogs(ctx context.Context, request SearchLogsRequest) (response SearchLogsResponse, err error)
SearchLogs Submit a query to search logs. See Using the API (https://docs.cloud.oracle.com/Content/Logging/Concepts/using_the_api_searchlogs.htm) for SDK examples.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/loggingsearch/SearchLogs.go.html to see an example of how to use SearchLogs API.
func (client *LogSearchClient) SetRegion(region string)
SetRegion overrides the region of this client.
SearchLogsDetails Search request object.
type SearchLogsDetails struct {
// Start filter log's date and time, in the format defined by RFC3339.
TimeStart *common.SDKTime `mandatory:"true" json:"timeStart"`
// End filter log's date and time, in the format defined by RFC3339.
TimeEnd *common.SDKTime `mandatory:"true" json:"timeEnd"`
// Query corresponding to the search operation. This query is parsed and validated before execution and
// should follow the specification. For more information on the query language specification, see
// Logging Query Language Specification (https://docs.cloud.oracle.com/Content/Logging/Reference/query_language_specification.htm).
SearchQuery *string `mandatory:"true" json:"searchQuery"`
// Whether to return field schema information for the log stream specified in searchQuery.
IsReturnFieldInfo *bool `mandatory:"false" json:"isReturnFieldInfo"`
}
func (m SearchLogsDetails) String() string
func (m SearchLogsDetails) 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
SearchLogsRequest wrapper for the SearchLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.1/loggingsearch/SearchLogs.go.html to see an example of how to use SearchLogsRequest.
type SearchLogsRequest struct {
// Search request.
SearchLogsDetails `contributesTo:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a response. Pagination is not supported in this API.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous "Search" call.
// For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request SearchLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SearchLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SearchLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SearchLogsRequest) String() string
func (request SearchLogsRequest) 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
SearchLogsResponse wrapper for the SearchLogs operation
type SearchLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SearchResponse instances
SearchResponse `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/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-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 SearchLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SearchLogsResponse) String() string
SearchResponse Search response object.
type SearchResponse struct {
Summary *SearchResultSummary `mandatory:"true" json:"summary"`
// List of search results
Results []SearchResult `mandatory:"false" json:"results"`
// List of log field schema information.
Fields []FieldInfo `mandatory:"false" json:"fields"`
}
func (m SearchResponse) String() string
func (m SearchResponse) 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
SearchResult A log search result entry.
type SearchResult struct {
// JSON blob containing the search entry with the projected fields.
Data *interface{} `mandatory:"true" json:"data"`
}
func (m SearchResult) String() string
func (m SearchResult) 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
SearchResultSummary Summary of results.
type SearchResultSummary struct {
// Total number of search results.
ResultCount *int `mandatory:"false" json:"resultCount"`
// Total number of field schema information.
FieldCount *int `mandatory:"false" json:"fieldCount"`
}
func (m SearchResultSummary) String() string
func (m SearchResultSummary) 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