Release v12.0.0-beta6

Breaking Changes

• Catalog service:

  • v2beta1:
    • Apis whose name ends with by_id have changed by removing by_id in the name , and apis whose name ends with by_resource_name have changed by removing by_resource_name in the name
    • Apis of create_workflow, create_workflow_build, create_workflow_run, delete_workflow_build_by_id, delete_workflow_by_id, delete_workflow_run_by_id, get_workflow_build_by_id, get_workflow_by_id, list_workflow_builds, list_workflow_runs, list_workflows were removed

• Seach service:

  • v2:
    • Apis of refresh_federated_connection() and test_federated_connection() removed the input parameter of body
  • v3alpha1:
    • Apis of refresh_federated_connection() and test_federated_connection() removed the input parameter of body

Non-Breaking Changes

• identity service:
  • v3:
    • Added new apis of get_entitlements, update_entitlements
• search sevice:
  • v2:
    • Added new apis of create_dataset,delete_dataset_by_id, get_all_federated_connections, get_dataset_by_id, list_datasets, update_dataset_by_id
  • v3alpha1:
    • Added new apis of get_all_federated_connections

Release v12.0.0-beta4

Non-Breaking Changes

• KVstore service (v1beta1): delete_recoreds() has added a new optional input parameter of enable_mvl; query_records() has added new optional input parameters of enable_mvl and shared

• Search service (v3alpha1): new api of list_datasets() is added

• Streams service (v3beta1): list_pipelines() has added a new optional input parameter of include_status; new api of delete_source() is added

Bug fixed

• Fix whitesource vulnerability

Release v12.0.0-beta3

Breaking Changes

Features

• Ingest service (v1beta2):

  • Model HECResponse has been removed

• KVStore service (v1beta1)

  • Model Key renamed to Record and has an additional required field user
  • Endpoints insert_record and put_record have returnType Record (earlier it was Key)

• Search service (v3alpha1)

  • Models RecurringSearch and UpdateRecurringSearch have been removed
  • Endpoint create_dataset takes in argument DatasetPOST instead of Dataset
  • Endpoint update_dataset_by_id takes in argument DatasetPATCH instead of Dataset
  • Endpoint delete_dataset_by_id has a returnType SSCVoidModel instead of Dataset
  • Endpoint list_spl2_modules has a returnType ListModules instead of List[Module]
  • Endpoints create_recurring_search, delete_recurring_search, get_all_jobs_for_recurring_search, get_job_for_recurring_search, get_recurring_search, list_recurring_searches and update_recurring_search have been removed

Non-Breaking Changes

Features

• Identity service (v3):

  • Models ResetPasswordBody, UpdateGroupBody, UpdatePasswordBody and UpdateRoleBody have been added
  • Endpoints reset_password, update_password, update_group and update_role have been added
  • Parameters description and display_name have been added to models CreateGroupBody, CreateRoleBody, Role, and Group

• Search service (v3alpha1)

  • Models DatasetPATCH, DatasetPOST, FederatedConnection, FederatedConnectionInput and ListModules have been added
  • Endpoints create_federated_connection, delete_federated_connection, get_federated_connection_by_name and put_federated_connection_by_name have been added

• Streams service (v3beta1)

  • Models PipelineReactivateResponseAsync, PipelineReactivationStatus, UpgradePipelineRequest and ValidateConnectionRequest have been added
  • Parameter skip_validation has been added to create_connection endpoint
  • Parameter create_user_id has been added to list_templates endpoint
  • Endpoints reactivation_status, validate_connection, and upgrade_pipeline have been added
  • Parameter metadata has been added to ConnectorResponse
  • Parameter labels has been added to PipelinePatchRequest, PipelineRequest and PipelineResponse models
  • Parameter uberJarSha256 has been added to PipelineResponse model
  • ACTIVATING and DEACTIVATING added to model PipelineResponse status enum
  • Model Source has changed with properties node and pipeline_version deleted and 18 new properties added
  • Parameter learn_more_location has been added to model TemplateResponse

• Added support to build a partial (without scheme) or full URL from "route" parameter and based on tenant specification in the context

Release v12.0.0-beta2

Breaking Changes

Features

• Identity service: use_default_idp optional property was removed from Tenant model in v2beta1 and v3

• Ingest service:

  • post_collector_raw and post_collector_rawV1 APIs were removed from v1beta2

• Search service:

  • renamed API of create_multi_search to create_job in v3alpha1

• Streams service: create_data_stream, delete_data_stream, describe_data_stream, list_data_streams, and update_data_stream APIs were removed in v3beta1

Non-Breaking Changes

• Search service:

  • updated to target v2 endpoints (previously v2beta1) including new endpoint of exportResults
  • added new APIs of create_spl2_module, delete_dataset_by_id, get_dataset_by_id, get_spl2_module_by_resource_name, update_dataset_by_id, list_spl2_modules in v3alpha1

• Ingest service:

  • added new API of upload_files in v1beta2

• Identity service:

  • added new APIs of create_identity_provider, delete_identity_provider, get_identity_provider, list_identity_provider, and update_identity_provider in v2beta1 and v3

  • New optional property accept_tos for CreatePrincipalProfile was added in v2beta1 and v3 and v3alpha1

• Streams service: Added new APIs of upload_file and upload_lookup_file

Release v12.0.0-beta1

Non-Breaking Changes

Features

• Multi-cell : Added support for tenant/region scoped hostnames to invoke tenant and system based api and auth domain endpoints :
  • New config settings in Context to create SDK Client-> tenantScoped bool, region
  • To enable tenantScoped(multi-cell), initialize context with tenantScoped to True
  • New config settings to enable tenantScoped in the Auth Manager during initialization, for ex: ClientAuthManager(host, client_id, client_secret, scope, tenant_scoped=true, region=“regionName”)
  • Enabling tenantScoped setting in the auth client will only generate tenant scoped tokens

Release v11.0.0

Services

Breaking Changes

Features

• Identity v2beta1:

  • Model AddInvisibleMemberBody removed
  • Endpoints add_invisible_member, get_member_admin and remove_member_admin removed

• Provisioner v1beta1

  • Models CreateProvisionJobBody, ProvisionJobInfo, ProvisionJobInfoErrors, ProvisionJobInfoErrors and
    ProvisionJobs removed
  • Endpoints create_provision_job, get_provision_job and list_provision_jobs removed

• Streams v3beta1:

  • Models CollectJobPatchRequest, CollectJobRequest, CollectJobResponse, CollectJobStartStopResponse,
    EntitlementRequest, EntitlementResponse, PaginatedResponseOfCollectJobResponse, PaginatedResponseOfPlugin,
    PaginatedResponseOfRulesResponse, PaginatedResponseOfRuleKind, Plugin, PluginPatchRequest, PluginRequest,
    PluginResponse, RulesRequest and RulesResponse removed

  • Model UploadFile renamed to UploadFileResponse

  • Endpoints create_collect_job, create_rules_package, delete_collect_jobs, delete_collect_job, delete_entitlements,
    delete_plugin, delete_rules_package, get_collect_job, get_entitlements, get_plugins, get_rules_package_by_id,
    list_collect_jobs, list_rules_kinds, list_rules_packages, patch_plugin, register_plugin, release_info,
    set_entitlements, start_collect_job, stop_collect_job, update_collect_job, update_plugin and update_rules_package_by_id
    removed

Non-Breaking Changes

Features

• Identity v2beta1:

  • New model CreatePrincipalBody added
  • New endpoint create_principal added

• Identity v3:

  • New version introduced

• Identity v3alpha1

  • New models GroupMemberList and GroupRoleListadded

• Ingest v1beta2:

  • New endpoints post_collector_raw and post_collector_raw_v1 added

• Streams v2beta1:

  • New property attributes added to ConnectorResponse
  • New property status_description added to PipelineReactivateResponse
  • New parameter functionOpadded to listConnections

• Streams v3beta1

  • New model UploadFileResponse added
  • New endpoint delete_lookup_file, get_lookup_file_metadata and get_lookup_files_metadata added

Release v10.0.0

Services

Breaking Changes

Features

• Catalog v2beta1:

  • create_dataset_import returns datatype of Dataset (replaced 'ImportDataset')
  • create_dataset_import_by_id returns DatasetImportedby (replaced 'ImportDataset')
  • DatasetImportedBy has a new property owner and property name is now optional

• Identity service v2beta1:

  • Models AppList, GroupList, Keylist, MemberList, PricipalList, RoleList, RolePermissionList and SubscriptionList removed
  • Property encode_state added to ResolveBody model
  • Property count removed from model IdentityProviderList
  • Property name removed from model SenstiveTenant
  • Properties count and details removed from models ServiceAccountList, TakedownPrincipalList, TenantList
  • Property items in model ServiceAccountList has a reference to ServiceAccount
  • Property items in model TakedownPrincipalList has a reference to TakedownPrincipal
  • Property items in model TenantList has a reference to Tenant

• Ingest v1beta2:

  • New properties ack_enabled, allow_query_string_auth, diabled and indexes added to models HecTokenAccessResponse, HecTokenCretaeRequest, HecTokenCreateResponse, HecTokenUpdateRequest
  • Remove endpoint of upload_files

• Provisioner v1beta1:

  • Model ECStackName renamed to EcStackName

• Search v2beta1:

  • Model ListSearchResultsResponseFields renamed to ListPreiviewResultsResponseFields

• Search v3alpha1:

  • Model ListSearchResultsResponseFields renamed to ListPreiviewResultsResponseFields

• Stream v3beta1:

  • Model RulesSourcetypesResponse renamed to RulesPackageSourcetypes
  • Model RulesActionsResponse renamed to RulesPackageActions

Non-Breaking Changes

Features

• Auth

  • ServicePrincipalAuthManager added to Auth service

• Identity v2beta1:

  • New model AddInvisibleMemberBody added
  • New endpoints add_invisible_member, get_member_admin and remove_member_admin added
  • New properties expires_at and visible added to Member model
  • New models DeviceAuthInfo and UpdateRoleBody added

• Identity v3alpha1:

  • New version introduced

• Ingest v1beta2:

  • New models UploadSuccessResponse and FileUploadDetails added

• KVStore v1beta1:

  • New endpoint truncate_records added

• Search v3alpha1:

  • New models SearchModule, StatementDispatchStatus, and SingleSatatementQueryParamters added
  • New endpoints create_multi_search_method and create_search_statements added

• Streams v2beta1:

  • New property messages added to model ConnectionSaveResponse
  • New property complexity added to model PipelineResponse
  • New property activate_latest_version added to model ReactivatePipelineRequest

• Streams v3beta1:

  • New models CollectJobPatchRequest, DataStream, DataStreamRequest, DataStreamResponse, EntitlementRequest,
    EntitlementResponse, PaginatedResponseOfRuleKind, RulesKind and PluginResponse
  • New endpoints create_data_stream, delete_collect_job, delete_data_stream, delete_entitlements, delete_rules_package,
    describe_data_stream, get_entitlements, get_rules_package_by_id, list_data_streams, list_rule_kinds, release_info,
    set_entitlements, update_collect_job, update_data_stream and update_rules_package_by_id added

Release v9.0.0

Version 9.0.0

Library

Breaking Changes

• App Registry
  • WebAppFromAppResponseGetList has been removed
  • WebAppPOST has been removed

Features

• Catalog
  • extract_fields has been added
• Search
  • extract_fields has been added
• Streams
  • PaginatedResponseOfCollectJobResponse has been added
  • RulesResponse has been added
  • RulesSourcetypesResponse has been added
  • RulesActionsResponse has been added
  • PaginatedResponseOfRulesResponse has been added
  • PaginatedResponseOfRulesResponse has been added
  • RulesRequest has been added

Services

Breaking Changes

• AppRegistry
  • Removed support for creating app of type WebApp,

Features

• Streams
  • New endpoints for CreateRulesPackage, GetRulesPackage, ListRulesPackage, ListCollectJobs have been added

Release v8.0.0

Breaking Changes

• Catalog service v2beta1: get_dataset, get_dataset_by_id and list_datasets endpoints now return data type of DatasetGet instead of Dataset

• Identify service v2beta1: remove endpoint of set_principal_public_keys

• Kvstore service v1beta1: insert_records endpoint has a new parameter of allow_updates

• Stream service v3beta1:

  • Remove endpoint: uploadPlugin
  • reactivate_pipeline has a new parameter of reactivate_pipeline_request

Non-Breaking Changes

• Identify service v2beta1:

  • new endpoints added: add_principal_public_key, get_principal_public_key, get_principal_public_keys, delete_principal_public_key, and update_principal_public_key

• Stream service v3beta1:

  • new endpoints added: startCollectJob,stopCollectJob

Release v7.0.0

Version 7.0.0

Library

Breaking Changes

Non-Breaking Changes

• App Registry
  • NativeAppFromAppResponseCreateUpdate has been added
  • NativeAppFromAppResponseGetList has been added
  • NativeAppPOST has been added
  • ServiceAppFromAppResponseCreateUpdate has been added
  • ServiceAppFromAppResponseGetList has been added
  • ServiceAppPOST has been added
• Collect
  • Execution has been added
  • ExecutionConflictError has been added
  • ExecutionPath has been added
  • SingleExecutionResponse has been added
• Ingest
  • HECResponse has been added
  • HECTokenAccessResponse has been added
  • HECTokenCreateRequest has been added
  • HECTokenCreateResponse has been added
  • HECTokenUpdateRequest has been added

Service

Breaking Changes

• Streams
  • In v3beta1:
    • Modified connector_id parameter to type List[str] in List_connections endpoint

Non-Breaking Changes

• Catalog

  • In v2beta1:
    • AppClientIDProperties model has been added

• Identity

  • In v2beta1:
    • Added scope_filter parameter to list_member_permissions endpoint
    • New Set_principale_public_keys endpoint

• Search

  • In v2beta:
    • Float typed parameter changed to Int for endpoints: List_events_summary, List_jobs, List_preview_results list_results

• Streams

  • New get_file_metadata endpoint

• New feature

  • 429 Retry Handling