cip

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Jan 8, 2022 License: Apache-2.0 Imports: 19 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")
)

Functions

func UserAgent 

func UserAgent() string

Types

type APIClient 

type APIClient struct {
	Cfg *Configuration
	// contains filtered or unexported fields
}

APIClient manages communication with the Sumo Logic API API v1.0.0 In most cases there should be only one, shared, APIClient.

func (*APIClient) AddAllowlistedCidrs 

func (a *APIClient) AddAllowlistedCidrs(body types.CidrList) (types.CidrList, *http.Response, error)

AddAllowlistedCidrs Add CIDR notations and/or IP addresses to the allowlist of the organization if not already there. When service allowlisting functionality is enabled, CIDRs/IP addresses that are allowlisted will have access to Sumo Logic and/or content sharing. 

body - List of all CIDR notations and/or IP addresses to be added to the allowlist of the organization.

func (*APIClient) AddContentPermissions 

func (a *APIClient) AddContentPermissions(body types.ContentPermissionUpdateRequest, id string, localVarOptionals *types.ContentPermissionsOpts) (types.ContentPermissionResult, *http.Response, error)

AddContentPermissions Add permissions to a content item with the given identifier. 

body - New permissions to add to the content item with the given identifier.
id - The identifier of the content item.
optional - nil or *types.ContentPermissionsOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) AssignCollectorToBudget 

func (a *APIClient) AssignCollectorToBudget(id string, collectorId string) (types.IngestBudget, *http.Response, error)

AssignCollectorToBudget Assign a Collector to a budget. 

id - Identifier of the ingest budget to assign to the Collector.
collectorId - Identifier of the Collector to assign.

func (*APIClient) AssignRoleToUser 

func (a *APIClient) AssignRoleToUser(roleId string, userId string) (types.RoleModel, *http.Response, error)

AssignRoleToUser Assigns a role to a user in the organization. 

roleId - Identifier of the role to assign.
userId - Identifier of the user to assign the role to.

func (*APIClient) AsyncCopyStatus 

func (a *APIClient) AsyncCopyStatus(id string, jobId string, localVarOptionals *types.ContentOpts) (types.AsyncJobStatus, *http.Response, error)

AsyncCopyStatus Gets the status of a copy request with the given jobId. 

id - The identifier of the content that was copied.
jobId - The identifier of the asynchronous copy request job.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) BeginAsyncCopy 

func (a *APIClient) BeginAsyncCopy(id string, destinationFolder string, localVarOptionals *types.ContentOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginAsyncCopy Start an asynchronous content copy job with the given identifier to the destination folder. If the content item is a folder, everything under the folder is copied recursively. 

id - The identifier of the content item to copy. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
destinationFolder - The identifier of the destination folder.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) BeginAsyncDelete 

func (a *APIClient) BeginAsyncDelete(id string, localVarOptionals *types.ContentOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginAsyncDelete Start an asynchronous content deletion job with the given identifier. 

id - Identifier of the content to delete. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) BeginAsyncExport 

func (a *APIClient) BeginAsyncExport(id string, localVarOptionals *types.ContentOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginAsyncExport Schedule an asynchronous export of content with the given identifier. You will get back an asynchronous job identifier on success. Use the GetAsyncExportStatus function and the job identifier you got back in the response to track the status of an asynchronous export job. If the content item is a folder, everything under the folder is exported recursively. Keep in mind when exporting large folders that there is a limit of 1000 content objects that can be exported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. The results from the export are compatible with the Library import feature in the Sumo Logic user interface as well as the API content import job. 

id - The identifier of the content item to export. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) BeginDashboardAsyncImport 

func (a *APIClient) BeginDashboardAsyncImport(body types.DashboardSyncDefinition, folderId string, localVarOptionals *types.ContentImportOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginDashboardAsyncImport Schedule an asynchronous import of dashboard content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the `overwrite` parameter to `true` to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. 

body - The content to import.
folderId - The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentImportOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.
	Overwrite (optional.Bool) - Set this to true to overwrite a content item if the name already exists.

func (*APIClient) BeginFolderAsyncImport 

func (a *APIClient) BeginFolderAsyncImport(body types.FolderSyncDefinition, folderId string, localVarOptionals *types.ContentImportOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginFolderAsyncImport Schedule an asynchronous import of folder content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the `overwrite` parameter to `true` to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. 

body - The content to import.
folderId - The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentImportOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.
	Overwrite (optional.Bool) - Set this to true to overwrite a content item if the name already exists.

func (*APIClient) BeginLookupTableAsyncImport 

func (a *APIClient) BeginLookupTableAsyncImport(body types.LookupTableSyncDefinition, folderId string, localVarOptionals *types.ContentImportOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginLookupTableAsyncImport Schedule an asynchronous import of lookup table content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the `overwrite` parameter to `true` to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. 

body - The content to import.
folderId - The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentImportOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.
	Overwrite (optional.Bool) - Set this to true to overwrite a content item if the name already exists.

func (*APIClient) BeginMetricsSavedSearchAsyncImport 

func (a *APIClient) BeginMetricsSavedSearchAsyncImport(body types.MetricsSavedSearchSyncDefinition, folderId string, localVarOptionals *types.ContentImportOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginMetricsSavedSearchAsyncImport Schedule an asynchronous import of metric saved searches content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the `overwrite` parameter to `true` to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. 

body - The content to import.
folderId - The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentImportOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.
	Overwrite (optional.Bool) - Set this to true to overwrite a content item if the name already exists.

func (*APIClient) BeginMetricsSearchAsyncImport 

func (a *APIClient) BeginMetricsSearchAsyncImport(body types.MetricsSearchSyncDefinition, folderId string, localVarOptionals *types.ContentImportOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginMetricsSearchAsyncImport Schedule an asynchronous import of metric searches content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the `overwrite` parameter to `true` to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. 

body - The content to import.
folderId - The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentImportOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.
	Overwrite (optional.Bool) - Set this to true to overwrite a content item if the name already exists.

func (*APIClient) BeginMewboardAsyncImport 

func (a *APIClient) BeginMewboardAsyncImport(body types.MewboardSyncDefinition, folderId string, localVarOptionals *types.ContentImportOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginMewboardAsyncImport Schedule an asynchronous import of mewboard content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the `overwrite` parameter to `true` to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. 

body - The content to import.
folderId - The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentImportOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.
	Overwrite (optional.Bool) - Set this to true to overwrite a content item if the name already exists.

func (*APIClient) BeginSavedSearchAsyncImport 

func (a *APIClient) BeginSavedSearchAsyncImport(body types.SavedSearchWithScheduleSyncDefinition, folderId string, localVarOptionals *types.ContentImportOpts) (types.BeginAsyncJobResponse, *http.Response, error)

BeginSavedSearchAsyncImport Schedule an asynchronous import of saved search content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the `overwrite` parameter to `true` to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. 

body - The content to import.
folderId - The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format.
optional - nil or *types.ContentImportOpts - Optional Parameters:
	IsAdminMode (optional.String) -  Set this to true if you want to perform the request as a Content Administrator.
	Overwrite (optional.Bool) -  Set this to true to overwrite a content item if the name already exists.

func (*APIClient) CancelRetentionUpdate 

func (a *APIClient) CancelRetentionUpdate(id string) (*http.Response, error)

CancelRetentionUpdate Cancel update to retention of a partition for which retention was updated previously using reduceRetentionPeriodImmediately parameter as false 

id - Identifier of the partition to cancel the retention update for.

func (*APIClient) ChangeBasePath 

func (a *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

func (*APIClient) CopyMonitors 

func (a *APIClient) CopyMonitors(body types.ContentCopyParams, id string) (types.MonitorsLibraryBaseResponse, *http.Response, error)

CopyMonitors Copy a monitor or folder in the monitors library. 

body - Details of the content to copy.
id - Identifier of the monitor or folder to copy.

func (*APIClient) CreateAWSS3ArchiveSource 

func (a *APIClient) CreateAWSS3ArchiveSource(body types.AWSS3ArchiveDefinition, collectorId string) (types.AWSS3ArchiveResponseModel, *http.Response, error)

CreateAWSS3ArchiveSource Create an AWS S3 Archive source. 

body - The definition of the AWS S3 Archive source.
collectorId - The identifier of the Sumo Logic collector to assign the source to.

func (*APIClient) CreateAccessKey 

func (a *APIClient) CreateAccessKey(body types.AccessKeyCreateRequest) (types.AccessKey, *http.Response, error)

CreateAccessKey Creates a new access ID and key pair. The new access key can be used from the domains specified in corsHeaders field. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:

  1. Requests with an ORIGIN header but the allowlist is empty.
  2. Requests with an ORIGIN header that don't match any entry in the allowlist.

func (*APIClient) CreateAllowlistedUser 

func (a *APIClient) CreateAllowlistedUser(userId string) (types.AllowlistedUserResult, *http.Response, error)

CreateAllowlistedUser Allowlist a user from SAML lockdown allowing them to sign in using a password in addition to SAML. 

userId - Identifier of the user.

func (*APIClient) CreateArchiveJob 

func (a *APIClient) CreateArchiveJob(body types.CreateArchiveJobRequest, sourceId string) (types.ArchiveJob, *http.Response, error)

CreateArchiveJob Create an ingestion job to pull data from your S3 bucket. 

body - The definition of the ingestion job to create.
sourceId - The identifier of the Archive Source for which the job is to be added.

func (*APIClient) CreateCollector 

func (a *APIClient) CreateCollector(body types.CreateCollectorRequest) (types.CollectorModel, *http.Response, error)

CreateCollector Create a new hosted collector in the organization. 

body - Information about the new collector

func (*APIClient) CreateDashboard 

func (a *APIClient) CreateDashboard(body types.DashboardRequest) (types.Dashboard, *http.Response, error)

CreateDashboard Creates a new dashboard. 

body - Information to create the new dashboard.

func (*APIClient) CreateDynamicParsingRule 

func (a *APIClient) CreateDynamicParsingRule(body types.DynamicRuleDefinition) (types.DynamicRule, *http.Response, error)

CreateDynamicParsingRule Create a new dynamic parsing rule. 

body - Information about the new dynamic parsing rule.

func (*APIClient) CreateEventHubSource 

func (a *APIClient) CreateEventHubSource(body types.CreateEventHubSourceRequest, collectorId string) (types.EventHubModel, *http.Response, error)

CreateEventHubSource Create an Azure Event Hub source. 

body - The definition of the Event Hub source.
collectorId - The identifier of the Sumo Logic collector to assign the source to.

func (*APIClient) CreateExtractionRule 

func (a *APIClient) CreateExtractionRule(body types.ExtractionRuleDefinition) (types.ExtractionRule, *http.Response, error)

CreateExtractionRule Create a new field extraction rule. 

body - Information about the new field extraction rule.

func (*APIClient) CreateField 

func (a *APIClient) CreateField(body types.FieldName) (types.CustomField, *http.Response, error)

CreateField Adding a field will define it in the Fields schema allowing it to be assigned as metadata to your logs. 

body - Name of a field to add. The name is used as the key in the key-value pair.

func (*APIClient) CreateFolder 

func (a *APIClient) CreateFolder(body types.FolderDefinition, localVarOptionals *types.FolderOpts) (types.Folder, *http.Response, error)

CreateFolder Creates a new folder under the given parent folder. 

body - Information about the new folder.
optional - nil or *types.FolderOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) CreateIdentityProvider 

func (a *APIClient) CreateIdentityProvider(body types.SamlIdentityProviderRequest) (types.SamlIdentityProvider, *http.Response, error)

CreateIdentityProvider Create a new SAML configuration in the organization. 

body - The configuration of the SAML identity provider.

func (*APIClient) CreateIngestBudget 

func (a *APIClient) CreateIngestBudget(body types.IngestBudgetDefinition) (types.IngestBudget, *http.Response, error)

CreateIngestBudget Create a new ingest budget. 

body - Information about the new ingest budget.

func (*APIClient) CreateIngestBudgetV2 

func (a *APIClient) CreateIngestBudgetV2(body types.IngestBudgetDefinitionV2) (types.IngestBudgetV2, *http.Response, error)

CreateIngestBudgetV2 Create a new ingest budget. 

body - Information about the new ingest budget.

func (*APIClient) CreateMetricsSearch 

func (a *APIClient) CreateMetricsSearch(body types.SaveMetricsSearchRequest) (types.MetricsSearchInstance, *http.Response, error)

CreateMetricsSearch Saves a metrics search in the content library. Metrics search consists of one or more queries, a time range, a quantization period and a set of chart properties like line width. 

body - The definition of the metrics search.

func (*APIClient) CreateMonitors 

func (a *APIClient) CreateMonitors(body types.MonitorsLibraryBase, parentId string) (types.MonitorsLibraryBaseResponse, *http.Response, error)

func (*APIClient) CreateOrganization 

func (a *APIClient) CreateOrganization(body types.OrganizationWithSubscriptionDetails, parentDeploymentId string) (types.ReadOrganizationResponse, *http.Response, error)

CreateOrganization Create a new child organization. 

body - Details about the organization to create.
parentDeploymentId - Deployment on which the calling organization resides.

func (*APIClient) CreateOrganizationAccessKey 

func (a *APIClient) CreateOrganizationAccessKey(body types.AccessKeyCreateRequest, parentDeploymentId string, orgId string) (types.AccessKey, *http.Response, error)

CreateOrganizationAccessKey Get an access ID and key pair for an existing organization based on the organization identifier. 

body - Access Key details.
parentDeploymentId - Deployment on which the calling organization resides.
orgId - Identifier of the organization for which the access ID and key pair is required.

func (*APIClient) CreatePartition 

func (a *APIClient) CreatePartition(body types.CreatePartitionDefinition) (types.Partition, *http.Response, error)

CreatePartition Create a new partition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Information about the new partition.

@return Partition

func (*APIClient) CreateRole 

func (a *APIClient) CreateRole(body types.CreateRoleDefinition) (types.RoleModel, *http.Response, error)

CreateRole Create a new role in the organization. 

body - Information about the new role.

func (*APIClient) CreateScheduledView 

func (a *APIClient) CreateScheduledView(body types.CreateScheduledViewDefinition) (types.ScheduledView, *http.Response, error)

CreateScheduledView Creates a new scheduled view in the organization. 

body - Information about the new scheduled view.

func (*APIClient) CreateServiceNowConnection 

func (a *APIClient) CreateServiceNowConnection(body types.ServiceNowDefinition) (types.ServiceNowConnection, *http.Response, error)

CreateServiceNowConnection Create a new ServiceNow connection in the organization. 

body - Information about the new ServiceNow connection.

func (*APIClient) CreateSubdomain 

func (a *APIClient) CreateSubdomain(body types.ConfigureSubdomainRequest) (types.SubdomainDefinitionResponse, *http.Response, error)

CreateSubdomain Create a subdomain. Only the Account Owner can create a subdomain. 

body - The new subdomain.

func (*APIClient) CreateTable 

func (a *APIClient) CreateTable(body types.LookupTableDefinition) (types.LookupTable, *http.Response, error)

CreateTable Create a new lookup table by providing a schema and specifying its configuration. Providing parentFolderId is mandatory. 

body - The schema and configuration for the lookup table.

func (*APIClient) CreateToken 

func (a *APIClient) CreateToken(body types.TokenBaseDefinition) (types.TokenBaseResponse, *http.Response, error)

CreateToken Create a token in the token library. 

body - Information about the token to create.

func (*APIClient) CreateTransformationRule 

func (a *APIClient) CreateTransformationRule(body types.TransformationRuleRequest) (types.TransformationRuleResponse, *http.Response, error)

CreateTransformationRule Create a new transformation rule. 

body - The configuration of the transformation rule to create.

func (*APIClient) CreateUpgradeOrDowngradeTask 

func (a *APIClient) CreateUpgradeOrDowngradeTask(body types.CreateUpgradeOrDowngradeRequest) (types.UpgradeOrDowngradeTaskModel, *http.Response, error)

CreateUpgradeOrDowngradeTask Creates a request to upgrade or downgrade a collector to a specific version.

func (*APIClient) CreateUser 

func (a *APIClient) CreateUser(body types.CreateUserDefinition) (types.UserModel, *http.Response, error)

CreateUser Create a new user in the organization. 

body - Information about the new user.

func (*APIClient) CreateWebhookConnection 

func (a *APIClient) CreateWebhookConnection(body types.WebhookDefinition) (types.WebhookConnection, *http.Response, error)

CreateWebhookConnection Create a new webhook connection in the organization. 

body - Information about the new webhook connection.

func (*APIClient) DecommissionPartition 

func (a *APIClient) DecommissionPartition(id string) (*http.Response, error)

DecommissionPartition Decommission a partition with the given identifier from the organization. 

id - Identifier of the partition to decommission.

func (*APIClient) DeleteAccessKey 

func (a *APIClient) DeleteAccessKey(id string) (*http.Response, error)

DeleteAccessKey Deletes the access key with the given accessId. 

id - The accessId of the access key to delete.

func (*APIClient) DeleteAllowlistedCidrs 

func (a *APIClient) DeleteAllowlistedCidrs(body types.CidrList) (types.CidrList, *http.Response, error)

DeleteAllowlistedCidrs Remove allowlisted CIDR notations and/or IP addresses from the organization. Removed CIDRs/IPs will immediately lose access to Sumo Logic and content sharing. 

body - List of all CIDR notations and/or IP addresses to be removed from the allowlist of the organization.

func (*APIClient) DeleteAllowlistedUser 

func (a *APIClient) DeleteAllowlistedUser(userId string) (*http.Response, error)

DeleteAllowlistedUser Remove an allowlisted user requiring them to sign in using SAML. 

userId - Identifier of user that will no longer be allowlisted from SAML Lockdown.

func (*APIClient) DeleteArchiveJob 

func (a *APIClient) DeleteArchiveJob(sourceId string, id string) (*http.Response, error)

DeleteArchiveJob Delete an ingestion job with the given identifier from the organization. The delete operation is only possible for jobs with a Succeeded or Failed status. 

sourceId - The identifier of the Archive Source.
id - The identifier of the ingestion job to delete.

func (*APIClient) DeleteCollectorById 

func (a *APIClient) DeleteCollectorById(id string) (*http.Response, error)

DeleteCollectorById Delete a collector with the given identifier from the organization. 

id - Identifier of the collector to delete.

func (*APIClient) DeleteConnection 

func (a *APIClient) DeleteConnection(id string, type_ string) (*http.Response, error)

DeleteConnection Delete a connection with the given identifier. 

id - Identifier of the connection to delete.
type_ - Type of connection to delete. Valid values are WebhookConnection, ServiceNowConnection.

func (*APIClient) DeleteDashboard 

func (a *APIClient) DeleteDashboard(id string) (*http.Response, error)

DeleteDashboard Delete a dashboard by the given identifier. 

id - Identifier of the dashboard to delete.

func (*APIClient) DeleteDynamicParsingRule 

func (a *APIClient) DeleteDynamicParsingRule(id string) (*http.Response, error)

DeleteDynamicParsingRule Delete a dynamic parsing rule with the given identifier. 

id - Identifier of the dynamic parsing rule to delete.

func (*APIClient) DeleteExtractionRule 

func (a *APIClient) DeleteExtractionRule(id string) (*http.Response, error)

DeleteExtractionRule Delete a field extraction rule with the given identifier. 

id - Identifier of the field extraction rule to delete.

func (*APIClient) DeleteField 

func (a *APIClient) DeleteField(id string) (*http.Response, error)

DeleteField Deleting a field does not delete historical data assigned with that field. If you delete a field by mistake and one or more of those dependencies break, you can re-add the field to get things working properly again. You should always disable a field and ensure things are behaving as expected before deleting a field. 

id - Identifier of a field to delete.

func (*APIClient) DeleteIdentityProvider 

func (a *APIClient) DeleteIdentityProvider(id string) (*http.Response, error)

DeleteIdentityProvider Delete a SAML configuration with the given identifier from the organization. 

id - Identifier of the SAML configuration to delete.

func (*APIClient) DeleteIngestBudget 

func (a *APIClient) DeleteIngestBudget(id string) (*http.Response, error)

DeleteIngestBudget Delete an ingest budget with the given identifier. 

id - Identifier of the ingest budget to delete.

func (*APIClient) DeleteIngestBudgetV2 

func (a *APIClient) DeleteIngestBudgetV2(id string) (*http.Response, error)

DeleteIngestBudgetV2 Delete an ingest budget with the given identifier. 

id - Identifier of the ingest budget to delete.

func (*APIClient) DeleteMetricsSearch 

func (a *APIClient) DeleteMetricsSearch(id string) (*http.Response, error)

DeleteMetricsSearch Deletes a metrics search from the content library. 

id - Identifier of the metrics search.

func (*APIClient) DeleteMonitorsById 

func (a *APIClient) DeleteMonitorsById(id string) (*http.Response, error)

DeleteMonitorsById Delete a monitor or folder from the monitors library. 

id - Identifier of the monitor or folder to delete.

func (*APIClient) DeleteMonitorsByIds 

func (a *APIClient) DeleteMonitorsByIds(ids []string) (map[string]types.MonitorsLibraryBaseResponse, *http.Response, error)

DeleteMonitorsByIds Bulk delete a monitor or folder by the given identifiers in the monitors library. 

ids - A comma-separated list of identifiers.

func (*APIClient) DeleteOfflineCollectors 

func (a *APIClient) DeleteOfflineCollectors(localVarOptionals *types.DeleteOfflineCollectorsOpts) (*http.Response, error)

DeleteOfflineCollectors Deletes offline collectors from the organization. 

	optional - nil or *types.DeleteOfflineCollectorsOpts - Optional Parameters:
 		AliveBeforeDays (optional.Int32) - Minimum number of days the Collectors have been offline.

func (*APIClient) DeleteOrganization 

func (a *APIClient) DeleteOrganization(orgId string, parentDeploymentId string) (types.ReadOrganizationResponse, *http.Response, error)

DeleteOrganization Deactivate an organization with the given identifier, deleting all its data and its subscription. 

orgId - Identifier of the organization to deactivate.
parentDeploymentId - Deployment on which the calling organization resides.

func (*APIClient) DeleteRole 

func (a *APIClient) DeleteRole(id string) (*http.Response, error)

DeleteRole Delete a role with the given identifier from the organization. 

id - Identifier of the role to delete.

func (*APIClient) DeleteSource 

func (a *APIClient) DeleteSource(collectorId string, sourceId string) (*http.Response, error)

DeleteSource Deletes the specified source from the specified collector. 

collectorId - Identifier of the collector that the source is attached to.
sourceId - Identifier of the source.

func (*APIClient) DeleteSubdomain 

func (a *APIClient) DeleteSubdomain() (*http.Response, error)

DeleteSubdomain Delete the configured subdomain.

func (*APIClient) DeleteTable 

func (a *APIClient) DeleteTable(id string) (*http.Response, error)

DeleteTable Delete a lookup table completely. 

id - Identifier of the lookup table.

func (*APIClient) DeleteTableRow 

func (a *APIClient) DeleteTableRow(body types.RowDeleteDefinition, id string) (*http.Response, error)

DeleteTableRow Delete a row from lookup table by giving primary key. The complete set of primary key fields of the lookup table should be provided. 

body - Lookup table row delete definition.
id - Identifier of the lookup table.

func (*APIClient) DeleteToken 

func (a *APIClient) DeleteToken(id string) (*http.Response, error)

DeleteToken Delete a token with the given identifier in the token library. 

id - Identifier of the token to delete.

func (*APIClient) DeleteTransformationRule 

func (a *APIClient) DeleteTransformationRule(id string) (*http.Response, error)

DeleteTransformationRule Delete a transformation rule with the given identifier. 

id - Identifier of the transformation rule to delete.

func (*APIClient) DeleteUser 

func (a *APIClient) DeleteUser(id string, localVarOptionals *types.DeleteUserOpts) (*http.Response, error)

DeleteUser Delete a user with the given identifier from the organization and transfer their content to the user with the identifier specified in transferTo. If transferTo is not specified the contents are deleted. 

id - Identifier of the user to delete.
optional - nil or *types.DeleteUserOpts - Optional Parameters:
	TransferTo (optional.String) -  Identifier of the user to receive the transfer of content from the deleted user.

func (*APIClient) DisableAllowlisting 

func (a *APIClient) DisableAllowlisting(allowlistType string) (*http.Response, error)

DisableAllowlisting Disable service allowlisting functionality for login/API authentication or content sharing for the organization. 

allowlistType - The type of allowlisting to be disabled. It can be one of: Login, Content, or Both.

func (*APIClient) DisableField 

func (a *APIClient) DisableField(id string) (*http.Response, error)

DisableField After disabling a field Sumo Logic will start dropping its incoming values at ingest. As a result, they won't be searchable or usable. Historical values are not removed and remain searchable. 

id - Identifier of a field to disable.

func (*APIClient) DisableMfa 

func (a *APIClient) DisableMfa(body types.DisableMfaRequest, id string) (*http.Response, error)

DisableMfa Disable multi-factor authentication for given user. 

body - Email and Password of the user to disable MFA for.
id - Identifier of the user to disable MFA for.

func (*APIClient) DisableSamlLockdown 

func (a *APIClient) DisableSamlLockdown() (*http.Response, error)

DisableSamlLockdown Disable SAML lockdown for the organization.

func (*APIClient) DisableScheduledView 

func (a *APIClient) DisableScheduledView(id string) (*http.Response, error)

DisableScheduledView Disable a scheduled view with the given identifier. 

id - Identifier of the scheduled view to disable.

func (*APIClient) EnableAllowlisting 

func (a *APIClient) EnableAllowlisting(allowlistType string) (*http.Response, error)

EnableAllowlisting Enable service allowlisting functionality for the organization. The service allowlisting can be for 1. Login: If enabled, access to Sumo Logic is granted only to CIDRs/IP addresses that are allowlisted. 2. Content: If enabled, dashboards can be shared with users connecting from CIDRs/IP addresses that are allowlisted without logging in. 

allowlistType - The type of allowlisting to be enabled. It can be one of: Login, Content, or Both.

func (*APIClient) EnableField 

func (a *APIClient) EnableField(id string) (*http.Response, error)

EnableField Fields have to be enabled to be assigned to your data. This operation ensures that a specified field is enabled and Sumo Logic will treat it as safe to process. All manually created custom fields are enabled by default. 

id - Identifier of a field to enable.

func (*APIClient) EnableSamlLockdown 

func (a *APIClient) EnableSamlLockdown() (*http.Response, error)

EnableSamlLockdown Enabling SAML lockdown requires users to sign in using SAML preventing them from logging in with an email and password.

func (*APIClient) ExportMonitorsItem 

func (a *APIClient) ExportMonitorsItem(id string) (types.MonitorsLibraryBaseExport, *http.Response, error)

ExportMonitorsItem Export a monitor or folder. If the given identifier is a folder, everything under the folder is exported recursively with folder as the root. 

id - Identifier of the monitor or folder to export.

func (*APIClient) GetAWSS3ArchiveSource 

func (a *APIClient) GetAWSS3ArchiveSource(collectorId string, sourceId string) (types.AWSS3ArchiveResponseModel, *http.Response, error)

GetAWSS3ArchiveSource Get information about an AWS S3 Archive source. 

collectorId - The identifier of the Sumo Logic collector that the source is assigned to.
sourceId - The identifier of the Sumo Logic AWS S3 Archive source.

func (*APIClient) GetAccountOwner 

func (a *APIClient) GetAccountOwner() (string, *http.Response, error)

GetAccountOwner Returns the user identifier of the account owner.

func (*APIClient) GetAdminRecommendedFolderAsync 

func (a *APIClient) GetAdminRecommendedFolderAsync(localVarOptionals *types.FolderOpts) (types.BeginAsyncJobResponse, *http.Response, error)

GetAdminRecommendedFolderAsync Schedule an asynchronous job to get the top-level Admin Recommended content items. 

optional - nil or *types.FolderOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetAdminRecommendedFolderAsyncResult 

func (a *APIClient) GetAdminRecommendedFolderAsyncResult(jobId string) (types.Folder, *http.Response, error)

GetAdminRecommendedFolderAsyncResult Get results from Admin Recommended job for the given job identifier. 

jobId - The identifier of the asynchronous Admin Recommended folder job.

func (*APIClient) GetAdminRecommendedFolderAsyncStatus 

func (a *APIClient) GetAdminRecommendedFolderAsyncStatus(jobId string) (types.AsyncJobStatus, *http.Response, error)

GetAdminRecommendedFolderAsyncStatus Get the status of an asynchronous Admin Recommended folder job for the given job identifier. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). 

jobId - The identifier of the asynchronous Admin Recommended folder job.

func (*APIClient) GetAllowlistedUsers 

func (a *APIClient) GetAllowlistedUsers() ([]types.AllowlistedUserResult, *http.Response, error)

GetAllowlistedUsers Get a list of allowlisted users.

func (*APIClient) GetAllowlistingStatus 

func (a *APIClient) GetAllowlistingStatus() (types.AllowlistingStatus, *http.Response, error)

GetAllowlistingStatus Get the status of the service allowlisting functionality for login/API authentication or content sharing for the organization.

func (*APIClient) GetApp 

func (a *APIClient) GetApp(uuid string) (types.App, *http.Response, error)

GetApp Gets the app with the given universally unique identifier (UUID). 

uuid - The identifier of the app to retrieve.

func (*APIClient) GetAssignedCollectors 

func (a *APIClient) GetAssignedCollectors(id string, localVarOptionals *types.ListIngestBudgetV1Opts) (types.ListCollectorIdentitiesResponse, *http.Response, error)

GetAssignedCollectors Get a list of Collectors assigned to an ingest budget. The response is paginated with a default limit of 100 Collectors per page. 

	id - Identifier of ingest budget to which Collectors are assigned.
 	optional - nil or *types.listIngestBudgetV1Opts - Optional Parameters:
		Limit (optional.Int32) - Limit the number of Collectors returned in the response. The number of Collectors returned may be less than the limit.
     	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results.

func (*APIClient) GetAsyncDeleteStatus 

func (a *APIClient) GetAsyncDeleteStatus(id string, jobId string, localVarOptionals *types.ContentOpts) (types.AsyncJobStatus, *http.Response, error)

GetAsyncDeleteStatus Get the status of an asynchronous content deletion job request for the given job identifier. 

id - Identifier of the content to delete.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) -  Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetAsyncExportResult 

func (a *APIClient) GetAsyncExportResult(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.ContentSyncDefinition, *http.Response, error)

GetAsyncExportResult Get results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface. You can use this function to find out type of content was exported and use one of the following functions to return the appropriate data for the content type: GetFolderAsyncExportResult, GetDashboardAsyncExportResult, GetMewboardAsyncExportResult, GetSavedSearchAsyncExportResult, GetMetricsSavedSearchAsyncExportResult, GetMetricsSearchAsyncExportResult, GetLookupTableAsyncExportResult. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetAsyncExportStatus 

func (a *APIClient) GetAsyncExportStatus(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.AsyncJobStatus, *http.Response, error)

GetAsyncExportStatus Get the status of an asynchronous content export request for the given job identifier. On success, use the [getExportResult](#operation/getAsyncExportResult) endpoint to get the result of the export job. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous export job.
optional - nil or *types.ContentManagementApiGetAsyncExportStatusOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetAsyncImportStatus 

func (a *APIClient) GetAsyncImportStatus(folderId string, jobId string, localVarOptionals *types.ContentOpts) (types.AsyncJobStatus, *http.Response, error)

GetAsyncImportStatus Get the status of a content import job for the given job identifier. 

folderId - The identifier of the folder to import into.
jobId - The identifier of the import request.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetAsyncInstallStatus 

func (a *APIClient) GetAsyncInstallStatus(jobId string) (types.AsyncJobStatus, *http.Response, error)

GetAsyncInstallStatus Get the status of an asynchronous app install request for the given job identifier. 

jobId - The identifier of the asynchronous install job.

func (*APIClient) GetAuditPolicy 

func (a *APIClient) GetAuditPolicy() (types.AuditPolicy, *http.Response, error)

GetAuditPolicy Get the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Audit-Index)

func (*APIClient) GetAvailableBuilds 

func (a *APIClient) GetAvailableBuilds() (types.GetAvailableBuildsModel, *http.Response, error)

GetAvailableBuilds Gets the available builds that collectors can be downgraded or upgraded to.

func (*APIClient) GetBuiltInField 

func (a *APIClient) GetBuiltInField(id string) (types.BuiltinField, *http.Response, error)

GetBuiltInField Get the details of a built-in field. 

id - Identifier of a built-in field.

func (*APIClient) GetCollectorById 

func (a *APIClient) GetCollectorById(id string) (types.CollectorModel, *http.Response, error)

GetCollectorById Gets information about a collector by its identifier. 

id - The identifier of the collector

func (*APIClient) GetCollectorByName 

func (a *APIClient) GetCollectorByName(name string) (types.CollectorModel, *http.Response, error)

GetCollectorByName Gets information about a collector by its name. 

name - The name of the collector

func (*APIClient) GetConnection 

func (a *APIClient) GetConnection(id string, type_ string) (types.Connection, *http.Response, error)

GetConnection Get a connection with the given identifier. 

id - Identifier of connection to return.
type_ - Type of connection to return. Valid values are WebhookConnection, ServiceNowConnections.

func (*APIClient) GetContentPermissions 

func (a *APIClient) GetContentPermissions(id string, localVarOptionals *types.GetContentPermissionsOpts) (types.ContentPermissionResult, *http.Response, error)

GetContentPermissions Returns content permissions of a content item with the given identifier. 

id - The identifier of the content item.
optional - nil or *types.GetContentPermissionsOpts - Optional Parameters:
	ExplicitOnly (optional.Bool) - There are two permission types: explicit and implicit. Permissions specifically assigned to the content item are explicit. Permissions derived from a parent content item, like a folder are implicit. To return only explicit permissions set this to true.
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetCustomField 

func (a *APIClient) GetCustomField(id string) (types.CustomField, *http.Response, error)

GetCustomField Get the details of a custom field. 

id - Identifier of a field.

func (*APIClient) GetDashboard 

func (a *APIClient) GetDashboard(id string) (types.Dashboard, *http.Response, error)

GetDashboard Get a dashboard by the given identifier. 

id - UUID of the dashboard to return.

func (*APIClient) GetDashboardAsyncExportResult 

func (a *APIClient) GetDashboardAsyncExportResult(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.DashboardSyncDefinition, *http.Response, error)

GetDashboardAsyncExportResult Get dashboard results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentManagementApiGetAsyncExportResultOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetDataAccessLevelPolicy 

func (a *APIClient) GetDataAccessLevelPolicy() (types.DataAccessLevelPolicy, *http.Response, error)

GetDataAccessLevelPolicy Get the Data Access Level policy. When enabled, this policy sets the default data access level for all newly created dashboards to the viewer’s role access filter. Otherwise, newly created dashboards will default to the sharer’s role access filter and might display data that viewers’ roles don’t allow them to view. [Learn More](https://help.sumologic.com/Manage/Security/Data_Access_Level_for_Shared_Dashboards)

func (*APIClient) GetDeployments 

func (a *APIClient) GetDeployments(parentDeploymentId string) ([]types.Deployment, *http.Response, error)

GetDeployments Get deployment details where organization can be created. 

parentDeploymentId - Deployment on which the calling organization resides.

func (*APIClient) GetDynamicParsingRule 

func (a *APIClient) GetDynamicParsingRule(id string) (types.DynamicRule, *http.Response, error)

GetDynamicParsingRule Get a dynamic parsing rule with the given identifier. 

id - Identifier of dynamic parsing rule to return.

func (*APIClient) GetEventHubSource 

func (a *APIClient) GetEventHubSource(collectorId string, sourceId string) (types.EventHubModel, *http.Response, error)

GetEventHubSource Get information about an Azure Event Hub source. 

collectorId - The identifier of the Sumo Logic collector that the source is assigned to.
sourceId - The identifier of the Sumo Logic Azure Event Hub source.

func (*APIClient) GetExtractionRule 

func (a *APIClient) GetExtractionRule(id string) (types.ExtractionRule, *http.Response, error)

GetExtractionRule Get a field extraction rule with the given identifier. 

id - Identifier of field extraction rule to return.

func (*APIClient) GetFieldQuota 

func (a *APIClient) GetFieldQuota() (types.FieldQuotaUsage, *http.Response, error)

GetFieldQuota Every account has a limited number of fields available. This endpoint returns your account limitations and remaining quota.

func (*APIClient) GetFolder 

func (a *APIClient) GetFolder(id string, localVarOptionals *types.FolderOpts) (types.Folder, *http.Response, error)

GetFolder Get a folder with the given identifier. 

id - Identifier of the folder to fetch.
optional - nil or *types.FolderOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetFolderAsyncExportResult 

func (a *APIClient) GetFolderAsyncExportResult(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.FolderSyncDefinition, *http.Response, error)

GetFolderAsyncExportResult Get folder results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentManagementApiGetAsyncExportResultOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetGlobalFolderAsync 

func (a *APIClient) GetGlobalFolderAsync(localVarOptionals *types.FolderOpts) (types.BeginAsyncJobResponse, *http.Response, error)

GetGlobalFolderAsync Schedule an asynchronous job to get global folder. Global folder contains all content items that a user has permissions to view in the organization. 

optional - nil or *types.FolderOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetGlobalFolderAsyncResult 

func (a *APIClient) GetGlobalFolderAsyncResult(jobId string) (types.ContentList, *http.Response, error)

GetGlobalFolderAsyncResult Get results from global folder job for the given job identifier. 

jobId - The identifier of the asynchronous global folder job.

func (*APIClient) GetGlobalFolderAsyncStatus 

func (a *APIClient) GetGlobalFolderAsyncStatus(jobId string) (types.AsyncJobStatus, *http.Response, error)

GetGlobalFolderAsyncStatus Get the status of an asynchronous global folder job for the given job identifier. 

jobId - The identifier of the asynchronous global folder job.

func (*APIClient) GetIdentityProviders 

func (a *APIClient) GetIdentityProviders() ([]types.SamlIdentityProvider, *http.Response, error)

GetIdentityProviders Get a list of all SAML configurations in the organization.

func (*APIClient) GetIngestBudget 

func (a *APIClient) GetIngestBudget(id string) (types.IngestBudget, *http.Response, error)

GetIngestBudget Get an ingest budget by the given identifier. 

id - Identifier of ingest budget to return.

func (*APIClient) GetIngestBudgetV2 

func (a *APIClient) GetIngestBudgetV2(id string) (types.IngestBudgetV2, *http.Response, error)

GetIngestBudgetV2 Get an ingest budget by the given identifier. 

id - Identifier of ingest budget to return.

func (*APIClient) GetItemByPath 

func (a *APIClient) GetItemByPath(path string) (types.Content, *http.Response, error)

GetItemByPath Get a content item corresponding to the given path. The absolute path to a content item should be specified to get the item. The content library has Library folder at the root level. For items in Personal folder, the base path is /Library/Users/user@sumo.com where user@sumo.com is the email address of the user. For example if a user with email address wile@acme.com has Rockets folder inside Personal folder, the path of Rockets folder will be /Library/Users/wile@acme.com/Rockets. For items in Admin Recommended folder, the base path is /Library/Admin Recommended. For example, given a folder Acme in Admin Recommended folder, the path will be /Library/Admin Recommended/Acme. 

path - Path of the content item to retrieve.

func (*APIClient) GetLogSearchEstimatedUsage 

func (a *APIClient) GetLogSearchEstimatedUsage(body types.LogSearchEstimatedUsageRequest) (types.LogSearchEstimatedUsageDefinition, *http.Response, error)

GetLogSearchEstimatedUsage Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier. 

body - The definition of the log search estimated usage.

func (*APIClient) GetLogSearchEstimatedUsageByTier 

func (a *APIClient) GetLogSearchEstimatedUsageByTier(body types.LogSearchEstimatedUsageRequestV2) (types.LogSearchEstimatedUsageByTierDefinition, *http.Response, error)

GetLogSearchEstimatedUsageByTier Gets the estimated volume of data that would be scanned for a given log search per data tier. 

body - The definition of the log search estimated usage.

func (*APIClient) GetLookupTableAsyncExportResult 

func (a *APIClient) GetLookupTableAsyncExportResult(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.LookupTableSyncDefinition, *http.Response, error)

GetLookupTableAsyncExportResult Get lookup table results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetMaxUserSessionTimeoutPolicy 

func (a *APIClient) GetMaxUserSessionTimeoutPolicy() (types.MaxUserSessionTimeoutPolicy, *http.Response, error)

GetMaxUserSessionTimeoutPolicy Get the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout)

func (*APIClient) GetMetricsSavedSearchAsyncExportResult 

func (a *APIClient) GetMetricsSavedSearchAsyncExportResult(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.MetricsSavedSearchSyncDefinition, *http.Response, error)

GetMetricsSavedSearchAsyncExportResult Get metrics saved search results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetMetricsSearch 

func (a *APIClient) GetMetricsSearch(id string) (types.MetricsSearchInstance, *http.Response, error)

GetMetricsSearch Returns a metrics search with the specified identifier. 

id - Identifier of the metrics search.

func (*APIClient) GetMetricsSearchAsyncExportResult 

func (a *APIClient) GetMetricsSearchAsyncExportResult(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.MetricsSearchSyncDefinition, *http.Response, error)

GetMetricsSearchAsyncExportResult Get metrics search results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetMewboardAsyncExportResult 

func (a *APIClient) GetMewboardAsyncExportResult(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.MewboardSyncDefinition, *http.Response, error)

GetMewboardAsyncExportResult Get mewboard results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetMonitorUsageInfo 

func (a *APIClient) GetMonitorUsageInfo() ([]types.MonitorUsage, *http.Response, error)

GetMonitorUsageInfo Get the current number and the allowed number of log and metrics monitors.

func (*APIClient) GetMonitorsById 

func (a *APIClient) GetMonitorsById(id string) (types.MonitorsLibraryBaseResponse, *http.Response, error)

GetMonitorsById Get a monitor or folder from the monitors library. 

id - Identifier of the monitor or folder to read.

func (*APIClient) GetMonitorsByIds 

func (a *APIClient) GetMonitorsByIds(ids []string) (map[string]types.MonitorsLibraryBaseResponse, *http.Response, error)

GetMonitorsByIds Bulk read a monitor or folder by the given identifiers from the monitors library. 

ids - A comma-separated list of identifiers.

func (*APIClient) GetMonitorsByPath 

func (a *APIClient) GetMonitorsByPath(path string) (types.MonitorsLibraryBaseResponse, *http.Response, error)

GetMonitorsByPath Read a monitor or folder by its path in the monitors library structure.

  • @param path The path of the monitor or folder.

func (*APIClient) GetMonitorsFullPath 

func (a *APIClient) GetMonitorsFullPath(id string) (types.Path, *http.Response, error)

GetMonitorsFullPath Get the full path of the monitor or folder in the monitors library. 

id - Identifier of the monitor or folder.

func (*APIClient) GetMonitorsLibraryRoot 

func (a *APIClient) GetMonitorsLibraryRoot() (types.MonitorsLibraryFolderResponse, *http.Response, error)

GetMonitorsLibraryRoot Get the root folder in the monitors library.

func (*APIClient) GetOrganization 

func (a *APIClient) GetOrganization(orgId string, parentDeploymentId string) (types.ReadOrganizationResponse, *http.Response, error)

GetOrganization Get details of an existing organization based on an organization identifier. 

orgId - Identifier of the organization for which the details are required.
parentDeploymentId - Deployment on which the calling organization resides.

func (*APIClient) GetOrganizationUsage 

func (a *APIClient) GetOrganizationUsage(orgId string, parentDeploymentId string) (types.DetailedUsage, *http.Response, error)

GetOrganizationUsage Get the detailed usage breakdown of an existing organization based on the organization identifier.

  • @param orgId Identifier of the organization for which the details are required.
  • @param parentDeploymentId Deployment on which the calling organization resides.

func (*APIClient) GetOrganizationUsages 

func (a *APIClient) GetOrganizationUsages(body []string, parentDeploymentId string, localVarOptionals *types.OrganizationsUsagesOpts) (types.ListUsagesResponse, *http.Response, error)

GetOrganizationUsages Get the credits usage details of all the given organizations. The response is paginated with a default limit of 100 organizations per page. 

body - List of the organizations for which usage needs to be fetched.
parentDeploymentId - Deployment on which the calling organization resides.
optional - nil or *types.OrganizationsUsagesOpts - Optional Parameters:
	Limit (optional.Int32) - Limit the number of results returned in the response. The number of results returned may be less than the limit.
	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

@return ListUsagesResponse

func (*APIClient) GetParentOrganizationDetails 

func (a *APIClient) GetParentOrganizationDetails(parentDeploymentId string) (types.ParentUsage, *http.Response, error)

GetParentOrganizationDetails Get the credits usage and allocation details of the current organization. 

parentDeploymentId - Deployment on which the calling organization resides.

func (*APIClient) GetParentOrganizationInfo 

func (a *APIClient) GetParentOrganizationInfo(parentDeploymentId string) (types.ParentOrgInfo, *http.Response, error)

GetParentOrganizationInfo Get information about parent organization. 

parentDeploymentId - Deployment on which the calling organization resides.

func (*APIClient) GetPartition 

func (a *APIClient) GetPartition(id string) (types.Partition, *http.Response, error)

GetPartition Get a partition with the given identifier from the organization. 

id - Identifier of partition to return.

func (*APIClient) GetPasswordPolicy 

func (a *APIClient) GetPasswordPolicy() (types.PasswordPolicy, *http.Response, error)

GetPasswordPolicy Get the current password policy.

func (*APIClient) GetPathById 

func (a *APIClient) GetPathById(contentId string) (types.ContentPath, *http.Response, error)

GetPathById Get full path of a content item with the given identifier. 

contentId - Identifier of the content item to get the path.

func (*APIClient) GetPersonalFolder 

func (a *APIClient) GetPersonalFolder() (types.Folder, *http.Response, error)

GetPersonalFolder Get the personal folder of the current user.

func (*APIClient) GetRole 

func (a *APIClient) GetRole(id string) (types.RoleModel, *http.Response, error)

GetRole Get a role with the given identifier in the organization. 

id - Identifier of the role to fetch.

func (*APIClient) GetSavedSearchAsyncExportResult 

func (a *APIClient) GetSavedSearchAsyncExportResult(contentId string, jobId string, localVarOptionals *types.ContentOpts) (types.SavedSearchWithScheduleSyncDefinition, *http.Response, error)

GetSavedSearchAsyncExportResult Get saved search results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface. 

contentId - The identifier of the exported content item.
jobId - The identifier of the asynchronous job.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) GetScheduledView 

func (a *APIClient) GetScheduledView(id string) (types.ScheduledView, *http.Response, error)

GetScheduledView Get a scheduled view with the given identifier. 

id - Identifier of the scheduled view to fetch.

func (*APIClient) GetSearchAuditPolicy 

func (a *APIClient) GetSearchAuditPolicy() (types.SearchAuditPolicy, *http.Response, error)

GetSearchAuditPolicy Get the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Search_Audit_Index)

func (*APIClient) GetShareDashboardsOutsideOrganizationPolicy 

func (a *APIClient) GetShareDashboardsOutsideOrganizationPolicy() (types.ShareDashboardsOutsideOrganizationPolicy, *http.Response, error)

GetShareDashboardsOutsideOrganizationPolicy Get the Share Dashboards Outside Organization policy. This policy allows users to share the dashboard with view only privileges outside of the organization (capability must be enabled from the Roles page). Disabling this policy will disable all dashboards that have been shared outside of the organization. [Learn More](https://help.sumologic.com/Visualizations-and-Alerts/Dashboards/Share_Dashboards/Share_a_Dashboard_Outside_Your_Org)

func (*APIClient) GetStatus 

func (a *APIClient) GetStatus() (types.AccountStatusResponse, *http.Response, error)

GetStatus Get information related to the accounts plan, pricing model, expiration and payment status.

func (*APIClient) GetSubdomain 

func (a *APIClient) GetSubdomain() (types.SubdomainDefinitionResponse, *http.Response, error)

GetSubdomain Get the configured subdomain.

func (*APIClient) GetSubdomainLoginUrl 

func (a *APIClient) GetSubdomainLoginUrl(orgId string, parentDeploymentId string) (types.Subdomain, *http.Response, error)

GetSubdomainLoginUrl Get the login URL for the subdomain configured organization based on the organization identifier. 

orgId - Identifier of the child organization for which the loginUrl is required.
parentDeploymentId - Deployment on which the calling organization resides.

func (*APIClient) GetToken 

func (a *APIClient) GetToken(id string) (types.TokenBaseResponse, *http.Response, error)

GetToken Get a token with the given identifier in the token library. 

id - Identifier of the token to return.

func (*APIClient) GetTransformationRule 

func (a *APIClient) GetTransformationRule(id string) (types.TransformationRuleResponse, *http.Response, error)

GetTransformationRule Get a transformation rule with the given identifier. 

id - Identifier of transformation rule to return.

func (*APIClient) GetUpgradableCollectors 

func (a *APIClient) GetUpgradableCollectors(localVarOptionals *types.GetUpgradableCollectorsOpts) (types.ListCollectorsModel, *http.Response, error)

GetUpgradableCollectors Gets a list of installed collectors that can be upgraded. 

optional - nil or *types.GetUpgradableCollectorsOpts - Optional Parameters:
	Limit (optional.Int32) - Limit the number of collectors returned in the response. The number of collectors returned may be less than the limit.
	Offset (optional.Int32) - Offset into the list of Collectors.
	ToVersion (optional.String) - Collector build to upgrade (or downgrade) to. If not specified, upgrades to the latest version.

func (*APIClient) GetUpgradeOrDowngradeTaskStatus 

func (a *APIClient) GetUpgradeOrDowngradeTaskStatus(id string) (types.UpgradeOrDowngradeTaskStatusModel, *http.Response, error)

GetUpgradeOrDowngradeTaskStatus Gets the status of a collector upgrade or downgrade task. 

id - Job id of the task.

func (*APIClient) GetUser 

func (a *APIClient) GetUser(id string) (types.UserModel, *http.Response, error)

GetUser Get a user with the given identifier from the organization. 

id - Identifier of user to return.

func (*APIClient) GetUserConcurrentSessionsLimitPolicy 

func (a *APIClient) GetUserConcurrentSessionsLimitPolicy() (types.UserConcurrentSessionsLimitPolicy, *http.Response, error)

GetUserConcurrentSessionsLimitPolicy Get the User Concurrent Sessions Limit policy. When enabled, the number of concurrent sessions a user may have is limited to the value entered. If a user exceeds the allowed number of sessions, the user's oldest session will be logged out to accommodate the new one. Disabling this policy means a user may have an unlimited number of concurrent sessions. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Limit_for_User_Concurrent_Sessions)

func (*APIClient) ImportMonitorsItem 

func (a *APIClient) ImportMonitorsItem(body types.MonitorsLibraryBaseExport, parentId string) (types.MonitorsLibraryBaseResponse, *http.Response, error)

ImportMonitorsItem Import a monitor or folder. 

body - The monitor or folder to be imported.
parentId - Identifier of the parent folder in which to import the monitor or folder.

func (*APIClient) InstallApp 

func (a *APIClient) InstallApp(body types.AppInstallRequest, uuid string) (types.BeginAsyncJobResponse, *http.Response, error)

InstallApp Installs the app with given UUID in the folder specified using destinationFolderId. 

body - Information for the new app
uuid - UUID of the app to install.

func (*APIClient) ListAccessKeys 

func (a *APIClient) ListAccessKeys(localVarOptionals *types.AccessKeyOpts) (types.PaginatedListAccessKeysResult, *http.Response, error)

ListAccessKeys List all access keys in your account. 

optional - nil or *types.AccessKeyOpts - Optional Parameters:
	Limit (optional.Int32) - Limit the number of access keys returned in the response. The number of access keys returned may be less than the limit.
	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

func (*APIClient) ListAllHealthEvents 

func (a *APIClient) ListAllHealthEvents(localVarOptionals *types.HealthEventsOpts) (types.ListHealthEventResponse, *http.Response, error)

ListAllHealthEvents Get a list of all the unresolved health events in your account. 

	optional - nil or *types.HealthEventsOpts - Optional Parameters:
		Limit (optional.Int32) - Limit the number of health events returned in the response. The number of health events returned may be less than the limit.
     	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

func (*APIClient) ListAllHealthEventsForResources 

func (a *APIClient) ListAllHealthEventsForResources(body types.ResourceIdentities, localVarOptionals *types.HealthEventsOpts) (types.ListHealthEventResponse, *http.Response, error)

ListAllHealthEventsForResources Get a list of all the unresolved events in your account that belong to the supplied resource identifiers. If you want to retrieve health events for a Source or Ingest Budget use the following functions: ListSourceHealthEvents or ListIngestBudgetHealthEvents 

	body - Resource identifiers to request health events from.
	optional - nil or *types.HealthEventsOpts - Optional Parameters:
		Limit (optional.Int32) - Limit the number of health events returned in the response. The number of health events returned may be less than the limit.
     	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

func (*APIClient) ListAllowlistedCidrs 

func (a *APIClient) ListAllowlistedCidrs() (types.CidrList, *http.Response, error)

ListAllowlistedCidrs Get a list of all allowlisted CIDR notations and/or IP addresses for the organization.

func (*APIClient) ListApps 

func (a *APIClient) ListApps() (types.ListAppsResult, *http.Response, error)

ListApps Lists all available apps from the App Catalog.

func (*APIClient) ListArchiveJobsBySourceId 

func (a *APIClient) ListArchiveJobsBySourceId(sourceId string, localVarOptionals *types.ArchiveOpts) (types.ListArchiveJobsResponse, *http.Response, error)

ListArchiveJobsBySourceId Get a list of all the ingestion jobs created on an Archive Source. The response is paginated with a default limit of 10 jobs per page. 

sourceId - The identifier of an Archive Source.
optional - nil or *types.ArchiveOpts - Optional Parameters:
	Limit (optional.Int32) - Limit the number of jobs returned in the response. The number of jobs returned may be less than the limit.
	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

func (*APIClient) ListArchiveJobsCountPerSource 

func (a *APIClient) ListArchiveJobsCountPerSource() (types.ListArchiveJobsCount, *http.Response, error)

ListArchiveJobsCountPerSource Get a list of all Archive Sources with the count and status of ingestion jobs.

func (*APIClient) ListBuiltInFields 

func (a *APIClient) ListBuiltInFields() (types.ListBuiltinFieldsResponse, *http.Response, error)

ListBuiltInFields Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include _sourceHost and _sourceCategory. Built-in fields can't be deleted or disabled.

func (*APIClient) ListCollectors 

func (a *APIClient) ListCollectors(localVarOptionals *types.ListCollectorsOpts) (types.ListCollectorsModel, *http.Response, error)

ListCollectors Get a list of collectors in the organization. The response has a default limit of 1000 collectors. 

optional - nil or *types.ListCollectorsOpts - Optional Parameters:
	Filter (optional.String) - Filter the Collectors returned using one of the available filter types: installed, hosted, dead or alive.
	Limit (optional.Int32) - Limit the number of collectors return in the response. The number of collectors returned may be less than the limit.
	Offset (optional.Int32) - Offset into the list of Collectors.

func (*APIClient) ListConnections 

func (a *APIClient) ListConnections(localVarOptionals *types.ConnectionsOpts) (types.ListConnectionsResponse, *http.Response, error)

ListConnections Get a list of all connections in the organization. The response is paginated with a default limit of 100 connections per page. 

optional - nil or *types.ConnectionOpts - Optional Parameters:
	Limit (optional.Int32) - Limit the number of connections returned in the response. The number of connections returned may be less than the limit.
	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

func (*APIClient) ListCustomFields 

func (a *APIClient) ListCustomFields() (types.ListCustomFieldsResponse, *http.Response, error)

ListCustomFields Request a list of all the custom fields configured in your account.

func (*APIClient) ListDroppedFields 

func (a *APIClient) ListDroppedFields() (types.ListDroppedFieldsResponse, *http.Response, error)

ListDroppedFields Dropped fields are fields sent to Sumo Logic, but are ignored since they are not defined in your Fields schema. In order to save these values a field must both exist and be enabled.

func (*APIClient) ListDynamicParsingRules 

func (a *APIClient) ListDynamicParsingRules(localVarOptionals *types.DynamicParsingRuleOpts) (types.ListDynamicRulesResponse, *http.Response, error)

ListDynamicParsingRules Get a list of all dynamic parsing rules. The response is paginated with a default limit of 100 dynamic parsing rules per page. 

optional - nil or *types.DynamicParsingRuleOpts - Optional Parameters:
	Limit (optional.Int32) - Limit the number of dynamic parsing rules returned in the response. The number of dynamic parsing rules returned may be less than the limit.
	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results.

func (*APIClient) ListExtractionRules 

func (a *APIClient) ListExtractionRules(localVarOptionals *types.ExtractionRuleOpts) (types.ListExtractionRulesResponse, *http.Response, error)

ListExtractionRules Get a list of all field extraction rules. The response is paginated with a default limit of 100 field extraction rules per page. 

	optional - nil or *types.ExtractionRuleOpts - Optional Parameters:
		Limit (optional.Int32) -  Limit the number of field extraction rules returned in the response. The number of field extraction rules returned may be less than the limit.
     	Token (optional.String) -  Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results.

func (*APIClient) ListIngestBudgets 

func (a *APIClient) ListIngestBudgets(localVarOptionals *types.ListIngestBudgetV1Opts) (types.ListIngestBudgetsResponse, *http.Response, error)

ListIngestBudgets Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page. 

	optional - nil or *types.ListIngestBudgetV1Opts - Optional Parameters:
		Limit (optional.Int32) - Limit the number of budgets returned in the response. The number of budgets returned may be less than the limit.
     	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results.

func (*APIClient) ListIngestBudgetsV2 

func (a *APIClient) ListIngestBudgetsV2(localVarOptionals *types.ListIngestBudgetV2Opts) (types.ListIngestBudgetsResponseV2, *http.Response, error)

ListIngestBudgetsV2 Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page. 

	optional - nil or *types.ListIngestBudgetV2Opts - Optional Parameters:
		Limit (optional.Int32) - Limit the number of budgets returned in the response. The number of budgets returned may be less than the limit.
     	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results.

func (*APIClient) ListOfflineCollectors 

func (a *APIClient) ListOfflineCollectors(localVarOptionals *types.ListCollectorsOfflineOpts) (types.ListCollectorsModel, *http.Response, error)

ListOfflineCollectors Get a list of offline collectors in the organization. The response has a default limit of 1000 collectors. 

optional - nil or *types.ListCollectorsOpts - Optional Parameters:
	AliveBeforeDays (optional.Int32) - Minimum number of days the Collectors have been offline.
	Limit (optional.Int32) - Limit the number of collectors returned in the response. The number of collectors returned may be less than the limit.
	Offset (optional.Int32) - Offset into the list of Collectors.

func (*APIClient) ListOrganizations 

func (a *APIClient) ListOrganizations(parentDeploymentId string, localVarOptionals *types.ListOrganizationsOpts) (types.ListOrganizationResponse, *http.Response, error)

ListOrganizations Get a list of all organizations in this account. The response is paginated with a default limit of 100 organizations per page. 

parentDeploymentId - Deployment on which the calling organization resides.
optional - nil or *types.ListOrganizationsOpts - Optional Parameters:
	Limit (optional.Int32) - Limit the number of organizations returned in the response. The number of organizations returned may be less than the `limit`.
	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.
	Status (optional.String) - Status of an organization, based on its subscription. Valid values are Active, Inactive, and All. By default, only active organizations are listed.

func (*APIClient) ListPartitions 

func (a *APIClient) ListPartitions(localVarOptionals *types.PartitionOpts) (types.ListPartitionsResponse, *http.Response, error)

ListPartitions Get a list of all partitions in the organization. The response is paginated with a default limit of 100 partitions per page. 

	optional - nil or *types.PartitionOpts - Optional Parameters:
		Limit (optional.Int32) - Limit the number of partitions returned in the response. The number of partitions returned may be less than the limit.
     	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.
     	ViewTypes (optional.Interface of []string) - The type of partitions to retrieve. More than one type of partitions can be retrieved in same request. Valid values are:
			DefaultView To get General Index partition.
			Partition To get user defined views/partitions.
			AuditIndex: To get the internal audit indexes.

func (*APIClient) ListPersonalAccessKeys 

func (a *APIClient) ListPersonalAccessKeys() (types.ListAccessKeysResult, *http.Response, error)

ListPersonalAccessKeys List all access keys that belong to your user.

func (*APIClient) ListRoles 

func (a *APIClient) ListRoles(localVarOptionals *types.ListRolesOpts) (types.ListRoleModelsResponse, *http.Response, error)

ListRoles Get a list of all the roles in the organization. The response is paginated with a default limit of 100 roles per page. 

optional - nil or *types.ListRolesOpts - Optional Parameters:
	Limit (optional.Int32) -  Limit the number of roles returned in the response. The number of roles returned may be less than the `limit`.
	Token (optional.String) -  Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. Token is set to null when no more pages are left.
	SortBy (optional.String) -  Sort the list of roles by the name field.
	Name (optional.String) -  Only return roles matching the given name.

func (*APIClient) ListScheduledViews 

func (a *APIClient) ListScheduledViews(localVarOptionals *types.ScheduledViewsOpts) (types.ListScheduledViewsResponse, *http.Response, error)

ListScheduledViews Get a list of all scheduled views in the organization. The response is paginated with a default limit of 100 scheduled views per page. 

optional - nil or *types.ScheduledViewsOpts - Optional Parameters:
	Limit (optional.Int32) - Limit the number of scheduled views returned in the response. The number of scheduled views returned may be less than the limit.
	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

func (*APIClient) ListSources 

func (a *APIClient) ListSources(collectorId string) (types.ListSourcesResponse, *http.Response, error)

ListSources Gets information about all Sources for a specified Collector. To get specific information about a source use the specific source Get function.

func (*APIClient) ListTokens 

func (a *APIClient) ListTokens() (types.ListTokensBaseResponse, *http.Response, error)

ListTokens Get a list of all tokens in the token library.

func (*APIClient) ListTransformationRules 

func (a *APIClient) ListTransformationRules(localVarOptionals *types.TransformationRulesOpts) (types.TransformationRulesResponse, *http.Response, error)

ListTransformationRules Get a list of transformation rules in the organization. The response is paginated with a default limit of 100 rules per page. 

	optional - nil or *types.TransformationRulesOpts - Optional Parameters:
		Limit (optional.Int32) - Limit the number of transformation rules returned in the response.
     	Token (optional.String) - Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

func (*APIClient) ListUsers 

func (a *APIClient) ListUsers(localVarOptionals *types.ListUsersOpts) (types.ListUserModelsResponse, *http.Response, error)

ListUsers Get a list of all users in the organization. The response is paginated with a default limit of 100 users per page. 

optional - nil or *types.ListUsersOpts - Optional Parameters:
	Limit (optional.Int32) -  Limit the number of users returned in the response. The number of users returned may be less than the limit.
	Token (optional.String) -  Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.
	SortBy (optional.String) -  Sort the list of users by the firstName, lastName, or email field.
	Email (optional.String) -  Find user with the given email address.

func (*APIClient) LookupTableById 

func (a *APIClient) LookupTableById(id string) (types.LookupTable, *http.Response, error)

LookupTableById Get a lookup table for the given identifier. 

id - Identifier of the lookup table.

func (*APIClient) MoveItem 

func (a *APIClient) MoveItem(destinationFolderId string, id string, localVarOptionals *types.ContentOpts) (*http.Response, error)

MoveItem Moves an item from its current location to another folder. 

destinationFolderId - Identifier of the destination folder.
id - Identifier of the item the user wants to move.
optional - nil or *types.ContentOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) MoveMonitors 

func (a *APIClient) MoveMonitors(id string, parentId string) (types.MonitorsLibraryBaseResponse, *http.Response, error)

MoveMonitors Move a monitor or folder to a different location in the monitors library. 

id - Identifier of the monitor or folder to move.
parentId - Identifier of the parent folder to move the monitor or folder to.

func (*APIClient) PauseScheduledView 

func (a *APIClient) PauseScheduledView(id string) (types.ScheduledView, *http.Response, error)

PauseScheduledView Pause a scheduled view with the given identifier. 

id - Identifier of the scheduled view to pause.

func (*APIClient) RecoverSubdomains 

func (a *APIClient) RecoverSubdomains(email string) (*http.Response, error)

RecoverSubdomains Send an email with the subdomain information for a user with the given email address. 

email - Email address of the user to get subdomain information.

func (*APIClient) RemoveCollectorFromBudget 

func (a *APIClient) RemoveCollectorFromBudget(id string, collectorId string) (types.IngestBudget, *http.Response, error)

RemoveCollectorFromBudget Remove Collector from a budget. 

id - Identifier of the ingest budget to unassign from the Collector.
collectorId - Identifier of the Collector to unassign.

func (*APIClient) RemoveContentPermissions 

func (a *APIClient) RemoveContentPermissions(body types.ContentPermissionUpdateRequest, id string, localVarOptionals *types.ContentPermissionsOpts) (types.ContentPermissionResult, *http.Response, error)

RemoveContentPermissions Remove permissions from a content item with the given identifier. 

body - Permissions to remove from a content item with the given identifier.
id - The identifier of the content item.
optional - nil or *types.ContentPermissionsOpts - Optional Parameters:
	IsAdminMode (optional.String) -  Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) RemoveRoleFromUser 

func (a *APIClient) RemoveRoleFromUser(roleId string, userId string) (*http.Response, error)

RemoveRoleFromUser Remove a role from a user in the organization. 

roleId - Identifier of the role to delete.
userId - Identifier of the user to remove the role from.

func (*APIClient) RequestChangeEmail 

func (a *APIClient) RequestChangeEmail(body types.ChangeEmailRequest, id string) (*http.Response, error)

RequestChangeEmail An email with an activation link is sent to the user’s new email address. The user must click the link in the email within seven days to complete the email address change, or the link will expire. 

body - New email address of the user.
id - Identifier of the user to change email address.

func (*APIClient) RequestJobStatus 

func (a *APIClient) RequestJobStatus(jobId string) (types.LookupAsyncJobStatus, *http.Response, error)

RequestJobStatus Retrieve the status of a previously made request. If the request was successful, the status of the response object will be Success. 

jobId - An identifier returned in response to an asynchronous request.

func (*APIClient) ResetPassword 

func (a *APIClient) ResetPassword(id string) (*http.Response, error)

ResetPassword Reset a user's password. 

id - Identifier of the user to reset password.

func (*APIClient) ResetUsage 

func (a *APIClient) ResetUsage(id string) (*http.Response, error)

ResetUsage Reset ingest budget's current usage to 0 before the scheduled reset time. 

id - Identifier of the ingest budget to reset usage.

func (*APIClient) ResetUsageV2 

func (a *APIClient) ResetUsageV2(id string) (*http.Response, error)

ResetUsageV2 Reset ingest budget's current usage to 0 before the scheduled reset time. 

id - Identifier of the ingest budget to reset usage.

func (*APIClient) RunMetricsQueries 

func (a *APIClient) RunMetricsQueries(body types.MetricsQueryRequest) (types.MetricsQueryResponse, *http.Response, error)

RunMetricsQueries Execute up to six metrics queries. If you specify multiple queries, each is returned as a separate set of time series. 

body - The parameters for the metrics query.

func (*APIClient) SearchMonitors 

func (a *APIClient) SearchMonitors(query string, localVarOptionals *types.MonitorsSearchOpts) ([]types.MonitorsLibraryItemWithPath, *http.Response, error)

SearchMonitors Search for a monitor or folder in the monitors library structure. 

query - The search query to find monitor or folder. The following is a list of different filters:
	**createdBy**: Filter by the user's identifier who created the content (createdBy:000000000000968B).
	**createdBefore**: Filter by the content objects created before the given timestamp(in milliseconds) (createdBefore:1457997222).
	**createdAfter**: Filter by the content objects created after the given timestamp(in milliseconds) (createdAfter:1457997111).
	**modifiedBefore**: Filter by the content objects modified before the given timestamp(in milliseconds) (modifiedBefore:1457997222).
	**modifiedAfter**:  Filter by the content objects modified after the given timestamp(in milliseconds) (modifiedAfter:1457997111).
	**type**: Filter by the type of the content object (type:folder).
	**monitorStatus**: Filter by the status of the monitor: Normal, Critical, Warning, MissingData, Disabled, AllTriggered (monitorStatus:Normal).
	You can also use multiple filters in one query. For example to search for all content objects created by user with identifier 000000000000968B with creation timestamp after 1457997222 containing the text Test, the query would look like:
optional - nil or *types.MonitorsSearchOpts - Optional Parameters:
	Limit (optional.Int32) - Maximum number of items you want in the response.
	Offset (optional.Int32) - The position or row from where to start the search operation.

func (*APIClient) SendMessage 

func (a *APIClient) SendMessage(maxRetries int, message string) *http.Response

SendMessage Allows you to send data to a Sumo Logic HTTP source endpoint. If sending the data to the endpoint fails it will retry every 10 seconds based on the value of maxRetries. 

maxRetries - determines how many times the message will attempt to be sent if there is an error sending.
message - data to send to the Sumo Logic source.

func (*APIClient) SetAuditPolicy 

func (a *APIClient) SetAuditPolicy(body types.AuditPolicy) (types.AuditPolicy, *http.Response, error)

SetAuditPolicy Set the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Audit-Index) 

body - Specifies if the policy is enabled or not

func (*APIClient) SetDataAccessLevelPolicy 

func (a *APIClient) SetDataAccessLevelPolicy(body types.DataAccessLevelPolicy) (types.DataAccessLevelPolicy, *http.Response, error)

SetDataAccessLevelPolicy Set the Data Access Level policy. When enabled, this policy sets the default data access level for all newly created dashboards to the viewer’s role access filter. Otherwise, newly created dashboards will default to the sharer’s role access filter and might display data that viewers’ roles don’t allow them to view. [Learn More](https://help.sumologic.com/Manage/Security/Data_Access_Level_for_Shared_Dashboards) 

body - Specifies if the policy is enabled or not

func (*APIClient) SetMaxUserSessionTimeoutPolicy 

func (a *APIClient) SetMaxUserSessionTimeoutPolicy(body types.MaxUserSessionTimeoutPolicy) (types.MaxUserSessionTimeoutPolicy, *http.Response, error)

SetMaxUserSessionTimeoutPolicy Set the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout) 

body - Specifies if the policy is enabled or not

func (*APIClient) SetPasswordPolicy 

func (a *APIClient) SetPasswordPolicy(body types.PasswordPolicy) (types.PasswordPolicy, *http.Response, error)

SetPasswordPolicy Update the current password policy. 

body - Specify the password policy.

func (*APIClient) SetSearchAuditPolicy 

func (a *APIClient) SetSearchAuditPolicy(body types.SearchAuditPolicy) (types.SearchAuditPolicy, *http.Response, error)

SetSearchAuditPolicy Set the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Search_Audit_Index) 

body - Specifies if the policy is enabled or not

func (*APIClient) SetShareDashboardsOutsideOrganizationPolicy 

func (a *APIClient) SetShareDashboardsOutsideOrganizationPolicy(body types.ShareDashboardsOutsideOrganizationPolicy) (types.ShareDashboardsOutsideOrganizationPolicy, *http.Response, error)

SetShareDashboardsOutsideOrganizationPolicy Set the Share Dashboards Outside Organization policy. This policy allows users to share the dashboard with view only privileges outside of the organization (capability must be enabled from the Roles page). Disabling this policy will disable all dashboards that have been shared outside of the organization. [Learn More](https://help.sumologic.com/Visualizations-and-Alerts/Dashboards/Share_Dashboards/Share_a_Dashboard_Outside_Your_Org) 

body - Specifies if the policy is enabled or not

func (*APIClient) SetUserConcurrentSessionsLimitPolicy 

func (a *APIClient) SetUserConcurrentSessionsLimitPolicy(body types.UserConcurrentSessionsLimitPolicy) (types.UserConcurrentSessionsLimitPolicy, *http.Response, error)

SetUserConcurrentSessionsLimitPolicy Set the User Concurrent Sessions Limit policy. When enabled, the number of concurrent sessions a user may have is limited to the value entered. If a user exceeds the allowed number of sessions, the user's oldest session will be logged out to accommodate the new one. Disabling this policy means a user may have an unlimited number of concurrent sessions. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Limit_for_User_Concurrent_Sessions) 

body - Specifies if the policy is enabled or not

func (*APIClient) StartScheduledView 

func (a *APIClient) StartScheduledView(id string) (types.ScheduledView, *http.Response, error)

StartScheduledView Start a scheduled view with the given identifier. 

id - Identifier of the scheduled view to start.

func (*APIClient) TestServiceNowConnection 

func (a *APIClient) TestServiceNowConnection(body types.ServiceNowDefinition) (types.TestConnectionResponse, *http.Response, error)

TestServiceNowConnection Test a new webhook connection url is valid and can connect. 

body - Information about the new webhook connection.

func (*APIClient) TestWebhookConnection 

func (a *APIClient) TestWebhookConnection(body types.WebhookDefinition) (types.TestConnectionResponse, *http.Response, error)

TestWebhookConnection Test a new webhook connection url is valid and can connect. 

body - Information about the new webhook connection.

func (*APIClient) TruncateTable 

func (a *APIClient) TruncateTable(id string) (types.LookupRequestToken, *http.Response, error)

TruncateTable Delete all data from a lookup table. 

id - Identifier of the table to clear.

func (*APIClient) UnlockUser 

func (a *APIClient) UnlockUser(id string) (*http.Response, error)

UnlockUser Unlock another user's account. 

id - The id of the user that needs to be unlocked.

func (*APIClient) UpdateAccessKey 

func (a *APIClient) UpdateAccessKey(body types.AccessKeyUpdateRequest, id string) (types.AccessKeyPublic, *http.Response, error)

UpdateAccessKey Updates the properties of existing accessKey by accessId. It can be used to enable or disable the access key and to update the corsHeaders list. 

body - Information to update about the access key
id - The accessId of the access key to update.

func (*APIClient) UpdateDashboard 

func (a *APIClient) UpdateDashboard(body types.DashboardRequest, id string) (types.Dashboard, *http.Response, error)

UpdateDashboard Update a dashboard by the given identifier. 

body - Information to update on the dashboard.
id - Identifier of the dashboard to update.

func (*APIClient) UpdateDynamicParsingRule 

func (a *APIClient) UpdateDynamicParsingRule(body types.DynamicRuleDefinition, id string) (types.DynamicRule, *http.Response, error)

UpdateDynamicParsingRule Update an existing dynamic parsing rule. All properties specified in the request are replaced. Missing properties are set to their default values. 

body - Information to update about the dynamic parsing rule.
id - Identifier of the dynamic parsing rule to update.

func (*APIClient) UpdateEventHubSource 

func (a *APIClient) UpdateEventHubSource(body types.UpdateEventHubSourceRequest, collectorId string, sourceId string) (types.EventHubModel, *http.Response, error)

UpdateEventHubSource Update an Azure Event Hub source. 

body - The definition of the Event Hub source.
collectorId - The identifier of the Sumo Logic collector that the source is assigned to.
sourceId - The identifier of the Sumo Logic source.

func (*APIClient) UpdateExtractionRule 

func (a *APIClient) UpdateExtractionRule(body types.UpdateExtractionRuleDefinition, id string) (types.ExtractionRule, *http.Response, error)

UpdateExtractionRule Update an existing field extraction rule. All properties specified in the request are replaced. Missing properties are set to their default values. 

	body - Information to update about the field extraction rule.
 	id - Identifier of the field extraction rule to update.

func (*APIClient) UpdateFolder 

func (a *APIClient) UpdateFolder(body types.UpdateFolderRequest, id string, localVarOptionals *types.FolderOpts) (types.Folder, *http.Response, error)

UpdateFolder Update an existing folder with the given identifier. 

body - Information to update about the folder.
id - Identifier of the folder to update.
optional - nil or *types.FolderOpts - Optional Parameters:
	IsAdminMode (optional.String) - Set this to true if you want to perform the request as a Content Administrator.

func (*APIClient) UpdateHostedCollector 

func (a *APIClient) UpdateHostedCollector(body types.UpdateHostedCollectorDefinition, id string) (types.CollectorModel, *http.Response, error)

UpdateHostedCollector Updates a hosted collector in the organization. 

body - Information to update about the collector.
id - Identifier of the hosted collector to update.

func (*APIClient) UpdateIdentityProvider 

func (a *APIClient) UpdateIdentityProvider(body types.SamlIdentityProviderRequest, id string) (types.SamlIdentityProvider, *http.Response, error)

UpdateIdentityProvider Update an existing SAML configuration in the organization. 

body - Information to update in the SAML configuration.
id - Identifier of the SAML configuration to update.

func (*APIClient) UpdateIngestBudget 

func (a *APIClient) UpdateIngestBudget(body types.IngestBudgetDefinition, id string) (types.IngestBudget, *http.Response, error)

UpdateIngestBudget Update an existing ingest budget. All properties specified in the request are required. 

body - Information to update about the ingest budget.
id - Identifier of the ingest budget to update.

func (*APIClient) UpdateIngestBudgetV2 

func (a *APIClient) UpdateIngestBudgetV2(body types.IngestBudgetDefinitionV2, id string) (types.IngestBudgetV2, *http.Response, error)

UpdateIngestBudgetV2 Update an existing ingest budget. All properties specified in the request are required. 

body - Information to update about the ingest budget.
id - Identifier of the ingest budget to update.

func (*APIClient) UpdateInstalledCollector 

func (a *APIClient) UpdateInstalledCollector(body types.UpdateInstalledCollectorDefinition, id string) (types.CollectorModel, *http.Response, error)

UpdateInstalledCollector Update an installed collector in the organization. 

body - Information to update about the collector.
id - Identifier of the installed collector to update.

func (*APIClient) UpdateMetricsSearch 

func (a *APIClient) UpdateMetricsSearch(body types.MetricsSearchV1, id string) (types.MetricsSearchInstance, *http.Response, error)

UpdateMetricsSearch Updates a metrics search with the specified identifier. Partial updates are not supported, you must provide values for all fields. 

body - An updated metrics search definition.
id - Identifier of the metrics search.

func (*APIClient) UpdateMonitorsById 

func (a *APIClient) UpdateMonitorsById(body types.MonitorsLibraryBaseUpdate, id string) (types.MonitorsLibraryBaseResponse, *http.Response, error)

UpdateMonitorsById Update a monitor or folder in the monitors library. 

body - The monitor or folder to update. The content version must match its latest version number in the monitors library. If the version does not match it will not be updated.
id - Identifier of the monitor or folder to update.

func (*APIClient) UpdateOrganization 

func (a *APIClient) UpdateOrganization(body types.Baselines, parentDeploymentId string, orgId string) (types.ReadOrganizationResponse, *http.Response, error)

UpdateOrganization Update an existing organization's subscription based on its identifier. 

body - The utilization baselines for the organization, which will determine their credits allocation. For organizations on Trial/Free plans, reallocating credits will upgrade their plan type to your plan. The plan change cannot be rolled back.
parentDeploymentId - Deployment on which the calling organization resides.
orgId - Identifier of the organization to update.

func (*APIClient) UpdatePartition 

func (a *APIClient) UpdatePartition(body types.UpdatePartitionDefinition, id string) (types.Partition, *http.Response, error)

UpdatePartition Update an existing partition in the organization. 

body - Information to update about the partition.
id - Identifier of the partition to update.

func (*APIClient) UpdateRole 

func (a *APIClient) UpdateRole(body types.UpdateRoleDefinition, id string) (types.RoleModel, *http.Response, error)

UpdateRole Update an existing role in the organization. 

body - Information to update about the role.
id - Identifier of the role to update.

func (*APIClient) UpdateScheduledView 

func (a *APIClient) UpdateScheduledView(body types.UpdateScheduledViewDefinition, id string) (types.ScheduledView, *http.Response, error)

UpdateScheduledView Update an existing scheduled view. 

body - Information to update about the scheduled view.
id - Identifier of the scheduled view to update.

func (*APIClient) UpdateServiceNowConnection 

func (a *APIClient) UpdateServiceNowConnection(body types.ServiceNowDefinition, id string) (types.ServiceNowConnection, *http.Response, error)

UpdateServiceNowConnection Update an existing ServiceNow connection. 

body - Information to update about the ServiceNow connection.
id - Identifier of the connection to update

func (*APIClient) UpdateSubdomain 

func (a *APIClient) UpdateSubdomain(body types.ConfigureSubdomainRequest) (types.SubdomainDefinitionResponse, *http.Response, error)

UpdateSubdomain Update a subdomain. Only the Account Owner can update the subdomain. 

body - The new subdomain.

func (*APIClient) UpdateTable 

func (a *APIClient) UpdateTable(body types.LookupUpdateDefinition, id string) (types.LookupTable, *http.Response, error)

UpdateTable Edit the lookup table data. All the fields are mandatory in the request. 

body - The configuration changes for the lookup table.
id - Identifier of the lookup table.

func (*APIClient) UpdateTableRow 

func (a *APIClient) UpdateTableRow(body types.RowUpdateDefinition, id string) (*http.Response, error)

UpdateTableRow Insert or update a row of a lookup table with the given identifier. A new row is inserted if the primary key does not exist already, otherwise the existing row with the specified primary key is updated. All the fields of the lookup table are required and will be updated to the given values. In case a field is not specified then it will be assumed to be set to null. If the table size exceeds the maximum limit of 100MB then based on the size limit action of the table the update will be processed or discarded. 

body - Lookup table row update definition.
id - Identifier of the lookup table.

func (*APIClient) UpdateToken 

func (a *APIClient) UpdateToken(body types.TokenBaseDefinitionUpdate, id string) (types.TokenBaseResponse, *http.Response, error)

UpdateToken Update a token with the given identifier in the token library. 

body - The token to update.
id - Identifier of the token to update.

func (*APIClient) UpdateTransformationRule 

func (a *APIClient) UpdateTransformationRule(body types.TransformationRuleRequest, id string) (types.TransformationRuleResponse, *http.Response, error)

UpdateTransformationRule Update an existing transformation rule. All properties specified in the request are replaced. 

body - Information to update about the transformation rule.
id - Identifier of the transformation rule to update.

func (*APIClient) UpdateUser 

func (a *APIClient) UpdateUser(body types.UpdateUserDefinition, id string) (types.UserModel, *http.Response, error)

UpdateUser Update an existing user in the organization. 

body - Information to update about the user.
id - Identifier of the user to update.

func (*APIClient) UpdateWebhookConnection 

func (a *APIClient) UpdateWebhookConnection(body types.WebhookDefinition, id string) (types.WebhookConnection, *http.Response, error)

UpdateWebhookConnection Update an existing webhook connection. 

body - Information to update about the webhook connection.
id - Identifier of the connection to update

func (*APIClient) UploadFile 

func (a *APIClient) UploadFile(file *os.File, id string, localVarOptionals *types.LookupTableUploadFileOpts) (types.LookupRequestToken, *http.Response, error)

UploadFile Create a request to populate a lookup table with a CSV file. 

file - A CSV file
id - Identifier of the lookup table to populate.
optional - nil or *types.LookupTableUploadFileOpts - Optional Parameters:
	Merge (optional.Bool) - This indicates whether the file contents will be merged with existing data in the lookup table or not. If this is true then data with the same primary keys will be updated while the rest of the rows will be appended. By default, merge is false. The response includes a request identifier that you need to use in the RequestJobStatus function to track the status of the upload request.
	FileEncoding (optional.String) - File encoding of file being uploaded.

func (*APIClient) ValidateMonitorQueries 

func (a *APIClient) ValidateMonitorQueries(body types.MonitorQueries) (types.MonitorQueriesValidationResult, *http.Response, error)

ValidateMonitorQueries Validate the query strings to make sure they are valid monitor queries. 

body - The queries that will be validated.

type BasicAuth 

type BasicAuth struct {
	AccessId  string `json:"userName,omitempty"`
	AccessKey string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	// Used for authenticating against the Sumo Logic API
	Authentication BasicAuth         `json:"authentication"`
	BasePath       string            `json:"basePath,omitempty"`
	Host           string            `json:"host,omitempty"`
	Scheme         string            `json:"scheme,omitempty"`
	DefaultHeader  map[string]string `json:"defaultHeader,omitempty"`
	UserAgent      string            `json:"userAgent,omitempty"`
	// Set this if you want to send data to a Sumo Logic source (only used with the SendMessage function)
	SourceUrl  string `json:"sourceUrl,omitempty"`
	HTTPClient *http.Client
}

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

Source Files

View all Source files

Directories

Path Synopsis

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.