threatintelligence

package
v65.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 23, 2022 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetDataVisibilityTlpNameEnumStringValues 

func GetDataVisibilityTlpNameEnumStringValues() []string

GetDataVisibilityTlpNameEnumStringValues Enumerates the set of values in String for DataVisibilityTlpNameEnum

func GetEntityReferenceTypeEnumStringValues 

func GetEntityReferenceTypeEnumStringValues() []string

GetEntityReferenceTypeEnumStringValues Enumerates the set of values in String for EntityReferenceTypeEnum

func GetIndicatorTypeEnumStringValues 

func GetIndicatorTypeEnumStringValues() []string

GetIndicatorTypeEnumStringValues Enumerates the set of values in String for IndicatorTypeEnum

func GetLifecycleStateEnumStringValues 

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListIndicatorCountsSortOrderEnumStringValues 

func GetListIndicatorCountsSortOrderEnumStringValues() []string

GetListIndicatorCountsSortOrderEnumStringValues Enumerates the set of values in String for ListIndicatorCountsSortOrderEnum

func GetListIndicatorsSortByEnumStringValues 

func GetListIndicatorsSortByEnumStringValues() []string

GetListIndicatorsSortByEnumStringValues Enumerates the set of values in String for ListIndicatorsSortByEnum

func GetListIndicatorsSortOrderEnumStringValues 

func GetListIndicatorsSortOrderEnumStringValues() []string

GetListIndicatorsSortOrderEnumStringValues Enumerates the set of values in String for ListIndicatorsSortOrderEnum

func GetListIndicatorsTypeEnumStringValues 

func GetListIndicatorsTypeEnumStringValues() []string

GetListIndicatorsTypeEnumStringValues Enumerates the set of values in String for ListIndicatorsTypeEnum

func GetListThreatTypesSortOrderEnumStringValues 

func GetListThreatTypesSortOrderEnumStringValues() []string

GetListThreatTypesSortOrderEnumStringValues Enumerates the set of values in String for ListThreatTypesSortOrderEnum

func GetSortOrderEnumStringValues 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

Types

type DataAttribution 

type DataAttribution struct {

	// Confidence is an integer from 0 to 100 that provides a measure of our certainty in the maliciousness of data attributed to an indicator.  For example, if the source of the data being attributed is the Tor Project, our confidence that the associated indicator is a tor exit node would be 100.
	Confidence *int `mandatory:"true" json:"confidence"`

	Source *IndicatorSourceSummary `mandatory:"true" json:"source"`

	Visibility *DataVisibility `mandatory:"true" json:"visibility"`

	// The last time this data was seen for this entity. An RFC3339 formatted datetime string
	TimeLastSeen *common.SDKTime `mandatory:"true" json:"timeLastSeen"`

	// The time the data was first seen for this entity. Defaults to time last seen if no time first seen is provided from the data source. An RFC3339 formatted datetime string
	TimeFirstSeen *common.SDKTime `mandatory:"false" json:"timeFirstSeen"`
}

DataAttribution The confidence, source information, and visibility for a particular sighting or observation of some data associated with an indicator such as threat type, attribute or relationship.

func (DataAttribution) String 

func (m DataAttribution) String() string

func (DataAttribution) ValidateEnumValue 

func (m DataAttribution) 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

type DataVisibility 

type DataVisibility struct {

	// The name of the visibility level.
	Name *string `mandatory:"true" json:"name"`

	// The Traffic Light Protocol (TLP) name of the visibility level.
	TlpName DataVisibilityTlpNameEnum `mandatory:"true" json:"tlpName"`
}

DataVisibility The visibility level associated with data and an associated TLP (https://www.cisa.gov/tlp) level.

func (DataVisibility) String 

func (m DataVisibility) String() string

func (DataVisibility) ValidateEnumValue 

func (m DataVisibility) 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

type DataVisibilityTlpNameEnum 

type DataVisibilityTlpNameEnum string

DataVisibilityTlpNameEnum Enum with underlying type: string 

const (
	DataVisibilityTlpNameInternalAudit DataVisibilityTlpNameEnum = "TLP_INTERNAL_AUDIT"
	DataVisibilityTlpNameWhite         DataVisibilityTlpNameEnum = "TLP_WHITE"
	DataVisibilityTlpNameGreen         DataVisibilityTlpNameEnum = "TLP_GREEN"
	DataVisibilityTlpNameAmber         DataVisibilityTlpNameEnum = "TLP_AMBER"
	DataVisibilityTlpNameRed           DataVisibilityTlpNameEnum = "TLP_RED"
)

Set of constants representing the allowable values for DataVisibilityTlpNameEnum

func GetDataVisibilityTlpNameEnumValues 

func GetDataVisibilityTlpNameEnumValues() []DataVisibilityTlpNameEnum

GetDataVisibilityTlpNameEnumValues Enumerates the set of values for DataVisibilityTlpNameEnum

func GetMappingDataVisibilityTlpNameEnum 

func GetMappingDataVisibilityTlpNameEnum(val string) (DataVisibilityTlpNameEnum, bool)

GetMappingDataVisibilityTlpNameEnum performs case Insensitive comparison on enum value and return the desired enum

type EntityReference 

type EntityReference interface {
}

EntityReference a reference to a resource or other entity

type EntityReferenceTypeEnum 

type EntityReferenceTypeEnum string

EntityReferenceTypeEnum Enum with underlying type: string 

const (
	EntityReferenceTypeIndicator EntityReferenceTypeEnum = "INDICATOR"
)

Set of constants representing the allowable values for EntityReferenceTypeEnum

func GetEntityReferenceTypeEnumValues 

func GetEntityReferenceTypeEnumValues() []EntityReferenceTypeEnum

GetEntityReferenceTypeEnumValues Enumerates the set of values for EntityReferenceTypeEnum

func GetMappingEntityReferenceTypeEnum 

func GetMappingEntityReferenceTypeEnum(val string) (EntityReferenceTypeEnum, bool)

GetMappingEntityReferenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type GetIndicatorRequest 

type GetIndicatorRequest struct {

	// unique indicator identifier
	IndicatorId *string `mandatory:"true" contributesTo:"path" name:"indicatorId"`

	// The ID of the tenancy to use to filter results.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

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

GetIndicatorRequest wrapper for the GetIndicator operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/GetIndicator.go.html to see an example of how to use GetIndicatorRequest.

func (GetIndicatorRequest) BinaryRequestBody 

func (request GetIndicatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetIndicatorRequest) HTTPRequest 

func (request GetIndicatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIndicatorRequest) RetryPolicy 

func (request GetIndicatorRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetIndicatorRequest) String 

func (request GetIndicatorRequest) String() string

func (GetIndicatorRequest) ValidateEnumValue 

func (request GetIndicatorRequest) 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

type GetIndicatorResponse 

type GetIndicatorResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Indicator instance
	Indicator `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"`
}

GetIndicatorResponse wrapper for the GetIndicator operation

func (GetIndicatorResponse) HTTPResponse 

func (response GetIndicatorResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetIndicatorResponse) String 

func (response GetIndicatorResponse) String() string

type Indicator 

type Indicator struct {

	// The OCID of the indicator.
	Id *string `mandatory:"true" json:"id"`

	// Type of indicator
	Type IndicatorTypeEnum `mandatory:"true" json:"type"`

	// The value for this indicator.
	// Format is dependent upon `type`, e.g. DOMAIN_NAME "evil.example.com", MD5_HASH "44d88612fea8a8f36de82e1278abb02f", IP_ADDRESS "2001:db8::1".
	Value *string `mandatory:"true" json:"value"`

	// Characteristics of the threat indicator based on previous observations or behavior. May include related tactics, techniques, and procedures.
	ThreatTypes []ThreatType `mandatory:"true" json:"threatTypes"`

	// A map of attribute name (string) to IndicatorAttribute (values and supporting data).
	// This provides generic storage for additional data about an indicator.
	Attributes []IndicatorAttribute `mandatory:"true" json:"attributes"`

	// A map of relationship name (string) to IndicatorRelationship (related entities and supporting data).
	// This provides generic storage for relationships between indicators or other entities.
	Relationships []IndicatorRelationship `mandatory:"true" json:"relationships"`

	// The time the data was first seen for this indicator. An RFC3339 formatted datetime string
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The last time this indicator was updated. It starts with the same value as timeCreated and is never empty. An RFC3339 formatted datetime string
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// Confidence is an integer from 0 to 100 that provides a measure of our certainty in the maliciousness of the indicator.  This confidence value is aggregated from the confidence in the threat types, attributes, and relationships to create an overall value for the indicator.
	Confidence *int `mandatory:"false" json:"confidence"`

	// Compartment Identifier
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The state of the indicator.  It will always be ACTIVE.  This field is added for consistency.
	LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

Indicator A data signature observed on a network or host that indicates a potential security threat. Indicators can be plain text or computed (hashed) values.

func (Indicator) String 

func (m Indicator) String() string

func (Indicator) ValidateEnumValue 

func (m Indicator) 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

type IndicatorAttribute 

type IndicatorAttribute struct {

	// The name of the attribute
	Name *string `mandatory:"true" json:"name"`

	// The value of the attribute.
	Value *string `mandatory:"true" json:"value"`

	// The array of attribution data that support this attribute.
	Attribution []DataAttribution `mandatory:"true" json:"attribution"`
}

IndicatorAttribute An attribute name and list of values.

func (IndicatorAttribute) String 

func (m IndicatorAttribute) String() string

func (IndicatorAttribute) ValidateEnumValue 

func (m IndicatorAttribute) 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

type IndicatorCountCollection 

type IndicatorCountCollection struct {

	// The list of aggregated indicator counts.
	Items []IndicatorCountSummary `mandatory:"true" json:"items"`
}

IndicatorCountCollection A list of indicator counts by indicator type.

func (IndicatorCountCollection) String 

func (m IndicatorCountCollection) String() string

func (IndicatorCountCollection) ValidateEnumValue 

func (m IndicatorCountCollection) 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

type IndicatorCountDimensions 

type IndicatorCountDimensions struct {

	// Compartment Identifier
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The indicator type that corresponds to the count.
	Type IndicatorTypeEnum `mandatory:"false" json:"type,omitempty"`
}

IndicatorCountDimensions Dimensions characterizing the group

func (IndicatorCountDimensions) String 

func (m IndicatorCountDimensions) String() string

func (IndicatorCountDimensions) ValidateEnumValue 

func (m IndicatorCountDimensions) 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

type IndicatorCountSummary 

type IndicatorCountSummary struct {
	Dimensions *IndicatorCountDimensions `mandatory:"true" json:"dimensions"`

	// The count of indicators in the group
	Count *int `mandatory:"true" json:"count"`
}

IndicatorCountSummary A group of indicators with the same dimensions

func (IndicatorCountSummary) String 

func (m IndicatorCountSummary) String() string

func (IndicatorCountSummary) ValidateEnumValue 

func (m IndicatorCountSummary) 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

type IndicatorReference 

type IndicatorReference struct {

	// the OCID of the referenced Indicator
	IndicatorId *string `mandatory:"true" json:"indicatorId"`
}

IndicatorReference a reference to an Indicator resource

func (IndicatorReference) MarshalJSON 

func (m IndicatorReference) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (IndicatorReference) String 

func (m IndicatorReference) String() string

func (IndicatorReference) ValidateEnumValue 

func (m IndicatorReference) 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

type IndicatorRelationship 

type IndicatorRelationship struct {

	// The name of the attribute
	Name *string `mandatory:"true" json:"name"`

	RelatedEntity EntityReference `mandatory:"true" json:"relatedEntity"`

	// The array of attribution data that support this SourcedRelationship
	Attribution []DataAttribution `mandatory:"true" json:"attribution"`
}

IndicatorRelationship An relationship name and list of releated entities.

func (IndicatorRelationship) String 

func (m IndicatorRelationship) String() string

func (*IndicatorRelationship) UnmarshalJSON 

func (m *IndicatorRelationship) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (IndicatorRelationship) ValidateEnumValue 

func (m IndicatorRelationship) 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

type IndicatorSourceSummary 

type IndicatorSourceSummary struct {

	// The name of the source
	Name *string `mandatory:"true" json:"name"`
}

IndicatorSourceSummary Information about the source of indicator data.

func (IndicatorSourceSummary) String 

func (m IndicatorSourceSummary) String() string

func (IndicatorSourceSummary) ValidateEnumValue 

func (m IndicatorSourceSummary) 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

type IndicatorSummary 

type IndicatorSummary struct {

	// The OCID of the indicator.
	Id *string `mandatory:"true" json:"id"`

	// Type of indicator
	Type IndicatorTypeEnum `mandatory:"true" json:"type"`

	// The value of indicator.
	Value *string `mandatory:"true" json:"value"`

	// Characteristics of the threat indicator based on previous observations or behavior. May include related tactics, techniques, and procedures.
	ThreatTypes []ThreatType `mandatory:"true" json:"threatTypes"`

	// The time the data was first seen for this indicator. An RFC3339 formatted datetime string
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The last time this indicator was updated. It starts with the same value as timeCreated and is never empty. An RFC3339 formatted datetime string
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// Confidence is an integer from 0 to 100 that provides a measure of our certainty in the maliciousness of the indicator.  This confidence value is aggregated from the confidence in the threat types, attributes, and relationships to create an overall value for the indicator.
	Confidence *int `mandatory:"false" json:"confidence"`

	// Compartment Identifier
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The state of the indicator.  It will always be ACTIVE.  This field is added for consistency.
	LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

IndicatorSummary Summary of a data signature observed on a network or host that indicates a potential security threat.

func (IndicatorSummary) String 

func (m IndicatorSummary) String() string

func (IndicatorSummary) ValidateEnumValue 

func (m IndicatorSummary) 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

type IndicatorSummaryCollection 

type IndicatorSummaryCollection struct {

	// The list of indicators
	Items []IndicatorSummary `mandatory:"true" json:"items"`
}

IndicatorSummaryCollection List of indicator summary objects.

func (IndicatorSummaryCollection) String 

func (m IndicatorSummaryCollection) String() string

func (IndicatorSummaryCollection) ValidateEnumValue 

func (m IndicatorSummaryCollection) 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

type IndicatorTypeEnum 

type IndicatorTypeEnum string

IndicatorTypeEnum Enum with underlying type: string 

const (
	IndicatorTypeDomainName IndicatorTypeEnum = "DOMAIN_NAME"
	IndicatorTypeFileName   IndicatorTypeEnum = "FILE_NAME"
	IndicatorTypeMd5Hash    IndicatorTypeEnum = "MD5_HASH"
	IndicatorTypeSha1Hash   IndicatorTypeEnum = "SHA1_HASH"
	IndicatorTypeSha256Hash IndicatorTypeEnum = "SHA256_HASH"
	IndicatorTypeIpAddress  IndicatorTypeEnum = "IP_ADDRESS"
	IndicatorTypeUrl        IndicatorTypeEnum = "URL"
)

Set of constants representing the allowable values for IndicatorTypeEnum

func GetIndicatorTypeEnumValues 

func GetIndicatorTypeEnumValues() []IndicatorTypeEnum

GetIndicatorTypeEnumValues Enumerates the set of values for IndicatorTypeEnum

func GetMappingIndicatorTypeEnum 

func GetMappingIndicatorTypeEnum(val string) (IndicatorTypeEnum, bool)

GetMappingIndicatorTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type LifecycleStateEnum 

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string 

const (
	LifecycleStateActive  LifecycleStateEnum = "ACTIVE"
	LifecycleStateDeleted LifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues 

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

func GetMappingLifecycleStateEnum 

func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)

GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIndicatorCountsRequest 

type ListIndicatorCountsRequest struct {

	// The ID of the tenancy to use to filter results.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListIndicatorCountsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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
}

ListIndicatorCountsRequest wrapper for the ListIndicatorCounts operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListIndicatorCounts.go.html to see an example of how to use ListIndicatorCountsRequest.

func (ListIndicatorCountsRequest) BinaryRequestBody 

func (request ListIndicatorCountsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIndicatorCountsRequest) HTTPRequest 

func (request ListIndicatorCountsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIndicatorCountsRequest) RetryPolicy 

func (request ListIndicatorCountsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIndicatorCountsRequest) String 

func (request ListIndicatorCountsRequest) String() string

func (ListIndicatorCountsRequest) ValidateEnumValue 

func (request ListIndicatorCountsRequest) 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

type ListIndicatorCountsResponse 

type ListIndicatorCountsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IndicatorCountCollection instance
	IndicatorCountCollection `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"`
}

ListIndicatorCountsResponse wrapper for the ListIndicatorCounts operation

func (ListIndicatorCountsResponse) HTTPResponse 

func (response ListIndicatorCountsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIndicatorCountsResponse) String 

func (response ListIndicatorCountsResponse) String() string

type ListIndicatorCountsSortOrderEnum 

type ListIndicatorCountsSortOrderEnum string

ListIndicatorCountsSortOrderEnum Enum with underlying type: string 

const (
	ListIndicatorCountsSortOrderAsc  ListIndicatorCountsSortOrderEnum = "ASC"
	ListIndicatorCountsSortOrderDesc ListIndicatorCountsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListIndicatorCountsSortOrderEnum

func GetListIndicatorCountsSortOrderEnumValues 

func GetListIndicatorCountsSortOrderEnumValues() []ListIndicatorCountsSortOrderEnum

GetListIndicatorCountsSortOrderEnumValues Enumerates the set of values for ListIndicatorCountsSortOrderEnum

func GetMappingListIndicatorCountsSortOrderEnum 

func GetMappingListIndicatorCountsSortOrderEnum(val string) (ListIndicatorCountsSortOrderEnum, bool)

GetMappingListIndicatorCountsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIndicatorsRequest 

type ListIndicatorsRequest struct {

	// The ID of the tenancy to use to filter results.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The result set will include indicators that have any of the provided threat types. To filter for multiple threat types repeat the query parameter.
	ThreatTypeName []string `contributesTo:"query" name:"threatTypeName" collectionFormat:"multi"`

	// The indicator type of entities to be returned.
	Type ListIndicatorsTypeEnum `mandatory:"false" contributesTo:"query" name:"type" omitEmpty:"true"`

	// The indicator value of entities to be returned.
	Value *string `mandatory:"false" contributesTo:"query" name:"value"`

	// The minimum confidence score of entities to be returned.
	ConfidenceGreaterThanOrEqualTo *int `mandatory:"false" contributesTo:"query" name:"confidenceGreaterThanOrEqualTo"`

	// The oldest update time of entities to be returned.
	TimeUpdatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeUpdatedGreaterThanOrEqualTo"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListIndicatorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. Only one field to sort by may be provided.
	SortBy ListIndicatorsSortByEnum `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
}

ListIndicatorsRequest wrapper for the ListIndicators operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListIndicators.go.html to see an example of how to use ListIndicatorsRequest.

func (ListIndicatorsRequest) BinaryRequestBody 

func (request ListIndicatorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIndicatorsRequest) HTTPRequest 

func (request ListIndicatorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIndicatorsRequest) RetryPolicy 

func (request ListIndicatorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIndicatorsRequest) String 

func (request ListIndicatorsRequest) String() string

func (ListIndicatorsRequest) ValidateEnumValue 

func (request ListIndicatorsRequest) 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

type ListIndicatorsResponse 

type ListIndicatorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of IndicatorSummaryCollection instances
	IndicatorSummaryCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListIndicatorsResponse wrapper for the ListIndicators operation

func (ListIndicatorsResponse) HTTPResponse 

func (response ListIndicatorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIndicatorsResponse) String 

func (response ListIndicatorsResponse) String() string

type ListIndicatorsSortByEnum 

type ListIndicatorsSortByEnum string

ListIndicatorsSortByEnum Enum with underlying type: string 

const (
	ListIndicatorsSortByConfidence  ListIndicatorsSortByEnum = "confidence"
	ListIndicatorsSortByTimeupdated ListIndicatorsSortByEnum = "timeUpdated"
)

Set of constants representing the allowable values for ListIndicatorsSortByEnum

func GetListIndicatorsSortByEnumValues 

func GetListIndicatorsSortByEnumValues() []ListIndicatorsSortByEnum

GetListIndicatorsSortByEnumValues Enumerates the set of values for ListIndicatorsSortByEnum

func GetMappingListIndicatorsSortByEnum 

func GetMappingListIndicatorsSortByEnum(val string) (ListIndicatorsSortByEnum, bool)

GetMappingListIndicatorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIndicatorsSortOrderEnum 

type ListIndicatorsSortOrderEnum string

ListIndicatorsSortOrderEnum Enum with underlying type: string 

const (
	ListIndicatorsSortOrderAsc  ListIndicatorsSortOrderEnum = "ASC"
	ListIndicatorsSortOrderDesc ListIndicatorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListIndicatorsSortOrderEnum

func GetListIndicatorsSortOrderEnumValues 

func GetListIndicatorsSortOrderEnumValues() []ListIndicatorsSortOrderEnum

GetListIndicatorsSortOrderEnumValues Enumerates the set of values for ListIndicatorsSortOrderEnum

func GetMappingListIndicatorsSortOrderEnum 

func GetMappingListIndicatorsSortOrderEnum(val string) (ListIndicatorsSortOrderEnum, bool)

GetMappingListIndicatorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIndicatorsTypeEnum 

type ListIndicatorsTypeEnum string

ListIndicatorsTypeEnum Enum with underlying type: string 

const (
	ListIndicatorsTypeDomainName ListIndicatorsTypeEnum = "DOMAIN_NAME"
	ListIndicatorsTypeFileName   ListIndicatorsTypeEnum = "FILE_NAME"
	ListIndicatorsTypeMd5Hash    ListIndicatorsTypeEnum = "MD5_HASH"
	ListIndicatorsTypeSha1Hash   ListIndicatorsTypeEnum = "SHA1_HASH"
	ListIndicatorsTypeSha256Hash ListIndicatorsTypeEnum = "SHA256_HASH"
	ListIndicatorsTypeIpAddress  ListIndicatorsTypeEnum = "IP_ADDRESS"
	ListIndicatorsTypeUrl        ListIndicatorsTypeEnum = "URL"
)

Set of constants representing the allowable values for ListIndicatorsTypeEnum

func GetListIndicatorsTypeEnumValues 

func GetListIndicatorsTypeEnumValues() []ListIndicatorsTypeEnum

GetListIndicatorsTypeEnumValues Enumerates the set of values for ListIndicatorsTypeEnum

func GetMappingListIndicatorsTypeEnum 

func GetMappingListIndicatorsTypeEnum(val string) (ListIndicatorsTypeEnum, bool)

GetMappingListIndicatorsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListThreatTypesRequest 

type ListThreatTypesRequest struct {

	// The ID of the tenancy to use to filter results.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListThreatTypesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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
}

ListThreatTypesRequest wrapper for the ListThreatTypes operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListThreatTypes.go.html to see an example of how to use ListThreatTypesRequest.

func (ListThreatTypesRequest) BinaryRequestBody 

func (request ListThreatTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListThreatTypesRequest) HTTPRequest 

func (request ListThreatTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListThreatTypesRequest) RetryPolicy 

func (request ListThreatTypesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListThreatTypesRequest) String 

func (request ListThreatTypesRequest) String() string

func (ListThreatTypesRequest) ValidateEnumValue 

func (request ListThreatTypesRequest) 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

type ListThreatTypesResponse 

type ListThreatTypesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ThreatTypesCollection instances
	ThreatTypesCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListThreatTypesResponse wrapper for the ListThreatTypes operation

func (ListThreatTypesResponse) HTTPResponse 

func (response ListThreatTypesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListThreatTypesResponse) String 

func (response ListThreatTypesResponse) String() string

type ListThreatTypesSortOrderEnum 

type ListThreatTypesSortOrderEnum string

ListThreatTypesSortOrderEnum Enum with underlying type: string 

const (
	ListThreatTypesSortOrderAsc  ListThreatTypesSortOrderEnum = "ASC"
	ListThreatTypesSortOrderDesc ListThreatTypesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListThreatTypesSortOrderEnum

func GetListThreatTypesSortOrderEnumValues 

func GetListThreatTypesSortOrderEnumValues() []ListThreatTypesSortOrderEnum

GetListThreatTypesSortOrderEnumValues Enumerates the set of values for ListThreatTypesSortOrderEnum

func GetMappingListThreatTypesSortOrderEnum 

func GetMappingListThreatTypesSortOrderEnum(val string) (ListThreatTypesSortOrderEnum, bool)

GetMappingListThreatTypesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type ThreatType 

type ThreatType struct {

	// The OCID of the threat type
	Id *string `mandatory:"true" json:"id"`

	// The name of the threat type
	Name *string `mandatory:"true" json:"name"`

	// The list of supporting attribution information.
	Attribution []DataAttribution `mandatory:"true" json:"attribution"`
}

ThreatType Threat type along with attribution data for its association to an indicator

func (ThreatType) String 

func (m ThreatType) String() string

func (ThreatType) ValidateEnumValue 

func (m ThreatType) 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

type ThreatTypeSummary 

type ThreatTypeSummary struct {

	// The OCID of the threat type
	Id *string `mandatory:"true" json:"id"`

	// The name of the threat type
	Name *string `mandatory:"true" json:"name"`
}

ThreatTypeSummary Threat type id and text

func (ThreatTypeSummary) String 

func (m ThreatTypeSummary) String() string

func (ThreatTypeSummary) ValidateEnumValue 

func (m ThreatTypeSummary) 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

type ThreatTypesCollection 

type ThreatTypesCollection struct {

	// The list of threat types that are available to query on
	Items []ThreatTypeSummary `mandatory:"true" json:"items"`
}

ThreatTypesCollection List of threat types applicable to indicators.

func (ThreatTypesCollection) String 

func (m ThreatTypesCollection) String() string

func (ThreatTypesCollection) ValidateEnumValue 

func (m ThreatTypesCollection) 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

type ThreatintelClient 

type ThreatintelClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

ThreatintelClient a client for Threatintel

func NewThreatintelClientWithConfigurationProvider 

func NewThreatintelClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ThreatintelClient, err error)

NewThreatintelClientWithConfigurationProvider Creates a new default Threatintel client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewThreatintelClientWithOboToken 

func NewThreatintelClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ThreatintelClient, err error)

NewThreatintelClientWithOboToken Creates a new default Threatintel 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 (*ThreatintelClient) ConfigurationProvider 

func (client *ThreatintelClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (ThreatintelClient) GetIndicator 

func (client ThreatintelClient) GetIndicator(ctx context.Context, request GetIndicatorRequest) (response GetIndicatorResponse, err error)

GetIndicator Gets a detailed indicator by identifier

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/GetIndicator.go.html to see an example of how to use GetIndicator API.

func (ThreatintelClient) ListIndicatorCounts 

func (client ThreatintelClient) ListIndicatorCounts(ctx context.Context, request ListIndicatorCountsRequest) (response ListIndicatorCountsResponse, err error)

ListIndicatorCounts Get the current count of each indicator type. Results can be sorted ASC or DESC by count.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListIndicatorCounts.go.html to see an example of how to use ListIndicatorCounts API.

func (ThreatintelClient) ListIndicators 

func (client ThreatintelClient) ListIndicators(ctx context.Context, request ListIndicatorsRequest) (response ListIndicatorsResponse, err error)

ListIndicators Returns a list of IndicatorSummary objects.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListIndicators.go.html to see an example of how to use ListIndicators API.

func (ThreatintelClient) ListThreatTypes 

func (client ThreatintelClient) ListThreatTypes(ctx context.Context, request ListThreatTypesRequest) (response ListThreatTypesResponse, err error)

ListThreatTypes Gets a list of threat types that are available to use as parameters when querying indicators. This is sorted by threat type name according to the sort order query param.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/threatintelligence/ListThreatTypes.go.html to see an example of how to use ListThreatTypes API.

func (*ThreatintelClient) SetRegion 

func (client *ThreatintelClient) SetRegion(region string)

SetRegion overrides the region of this client.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.