cribl-control-plane 0.0.31__py3-none-any.whl → 0.0.32__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of cribl-control-plane might be problematic. Click here for more details.

Files changed (49) hide show
  1. cribl_control_plane/_version.py +3 -3
  2. cribl_control_plane/branches.py +6 -6
  3. cribl_control_plane/commits.py +36 -36
  4. cribl_control_plane/commits_files.py +16 -16
  5. cribl_control_plane/destinations.py +18 -18
  6. cribl_control_plane/destinations_pq.py +10 -10
  7. cribl_control_plane/hectokens.py +10 -10
  8. cribl_control_plane/lakedatasets.py +36 -36
  9. cribl_control_plane/models/createcribllakedatasetbylakeidop.py +2 -2
  10. cribl_control_plane/models/createinputhectokenbyidop.py +2 -2
  11. cribl_control_plane/models/createoutputtestbyidop.py +2 -2
  12. cribl_control_plane/models/createversionundoop.py +2 -2
  13. cribl_control_plane/models/deletecribllakedatasetbylakeidandidop.py +4 -4
  14. cribl_control_plane/models/deleteinputbyidop.py +2 -2
  15. cribl_control_plane/models/deleteoutputbyidop.py +2 -2
  16. cribl_control_plane/models/deleteoutputpqbyidop.py +2 -2
  17. cribl_control_plane/models/deletepacksbyidop.py +2 -2
  18. cribl_control_plane/models/getconfiggroupaclteamsbyproductandidop.py +3 -3
  19. cribl_control_plane/models/getcribllakedatasetbylakeidandidop.py +4 -4
  20. cribl_control_plane/models/getcribllakedatasetbylakeidop.py +2 -2
  21. cribl_control_plane/models/getinputbyidop.py +2 -2
  22. cribl_control_plane/models/getmasterworkerentryop.py +2 -2
  23. cribl_control_plane/models/getoutputbyidop.py +2 -2
  24. cribl_control_plane/models/getoutputpqbyidop.py +2 -2
  25. cribl_control_plane/models/getoutputsamplesbyidop.py +2 -2
  26. cribl_control_plane/models/getpacksop.py +2 -2
  27. cribl_control_plane/models/getsummaryop.py +3 -3
  28. cribl_control_plane/models/getversioncountop.py +4 -4
  29. cribl_control_plane/models/getversiondiffop.py +8 -8
  30. cribl_control_plane/models/getversionfilesop.py +4 -4
  31. cribl_control_plane/models/getversionshowop.py +8 -8
  32. cribl_control_plane/models/getversionstatusop.py +2 -2
  33. cribl_control_plane/models/listmasterworkerentryop.py +23 -23
  34. cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py +4 -4
  35. cribl_control_plane/models/updateinputbyidop.py +2 -2
  36. cribl_control_plane/models/updateinputhectokenbyidandtokenop.py +4 -4
  37. cribl_control_plane/models/updateoutputbyidop.py +2 -2
  38. cribl_control_plane/models/updatepacksbyidop.py +2 -2
  39. cribl_control_plane/nodes.py +30 -30
  40. cribl_control_plane/packs.py +16 -16
  41. cribl_control_plane/samples.py +10 -10
  42. cribl_control_plane/sources.py +18 -18
  43. cribl_control_plane/statuses.py +6 -6
  44. cribl_control_plane/summaries.py +6 -6
  45. cribl_control_plane/teams.py +2 -2
  46. cribl_control_plane/versions_configs.py +4 -4
  47. {cribl_control_plane-0.0.31.dist-info → cribl_control_plane-0.0.32.dist-info}/METADATA +22 -22
  48. {cribl_control_plane-0.0.31.dist-info → cribl_control_plane-0.0.32.dist-info}/RECORD +49 -49
  49. {cribl_control_plane-0.0.31.dist-info → cribl_control_plane-0.0.32.dist-info}/WHEEL +0 -0
@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class GetVersionFilesRequestTypedDict(TypedDict):
13
13
  group: NotRequired[str]
14
- r"""Group ID"""
14
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for."""
15
15
  id: NotRequired[str]
16
- r"""Commit ID"""
16
+ r"""The Git commit hash to use as the starting point for the request."""
17
17
 
18
18
 
19
19
  class GetVersionFilesRequest(BaseModel):
@@ -21,14 +21,14 @@ class GetVersionFilesRequest(BaseModel):
21
21
  Optional[str],
22
22
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
23
23
  ] = None
24
- r"""Group ID"""
24
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for."""
25
25
 
26
26
  id: Annotated[
27
27
  Optional[str],
28
28
  pydantic.Field(alias="ID"),
29
29
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
30
30
  ] = None
31
- r"""Commit ID"""
31
+ r"""The Git commit hash to use as the starting point for the request."""
32
32
 
33
33
 
34
34
  class GetVersionFilesResponseTypedDict(TypedDict):
@@ -10,13 +10,13 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetVersionShowRequestTypedDict(TypedDict):
12
12
  commit: NotRequired[str]
13
- r"""Commit hash (default is HEAD)"""
13
+ r"""The Git commit hash to retrieve the diff and log message for."""
14
14
  group: NotRequired[str]
15
- r"""Group ID"""
15
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for."""
16
16
  filename: NotRequired[str]
17
- r"""Filename"""
17
+ r"""The relative path of the file to get the diff and log message for."""
18
18
  diff_line_limit: NotRequired[float]
19
- r"""Limit maximum lines in the diff"""
19
+ r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
20
20
 
21
21
 
22
22
  class GetVersionShowRequest(BaseModel):
@@ -24,26 +24,26 @@ class GetVersionShowRequest(BaseModel):
24
24
  Optional[str],
25
25
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
26
26
  ] = None
27
- r"""Commit hash (default is HEAD)"""
27
+ r"""The Git commit hash to retrieve the diff and log message for."""
28
28
 
29
29
  group: Annotated[
30
30
  Optional[str],
31
31
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
32
32
  ] = None
33
- r"""Group ID"""
33
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for."""
34
34
 
35
35
  filename: Annotated[
36
36
  Optional[str],
37
37
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
38
38
  ] = None
39
- r"""Filename"""
39
+ r"""The relative path of the file to get the diff and log message for."""
40
40
 
41
41
  diff_line_limit: Annotated[
42
42
  Optional[float],
43
43
  pydantic.Field(alias="diffLineLimit"),
44
44
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
45
45
  ] = None
46
- r"""Limit maximum lines in the diff"""
46
+ r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
47
47
 
48
48
 
49
49
  class GetVersionShowResponseTypedDict(TypedDict):
@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetVersionStatusRequestTypedDict(TypedDict):
12
12
  group: NotRequired[str]
13
- r"""Group ID"""
13
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the status for."""
14
14
 
15
15
 
16
16
  class GetVersionStatusRequest(BaseModel):
@@ -18,7 +18,7 @@ class GetVersionStatusRequest(BaseModel):
18
18
  Optional[str],
19
19
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
20
20
  ] = None
21
- r"""Group ID"""
21
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the status for."""
22
22
 
23
23
 
24
24
  class GetVersionStatusResponseTypedDict(TypedDict):
@@ -11,17 +11,17 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class ListMasterWorkerEntryRequestTypedDict(TypedDict):
13
13
  filter_exp: NotRequired[str]
14
- r"""Filter expression evaluated against nodes"""
15
- sort: NotRequired[str]
16
- r"""Sorting object (JSON stringified) expression evaluated against nodes"""
14
+ r"""Filter expression to evaluate against Nodes for inclusion in the response."""
17
15
  sort_exp: NotRequired[str]
18
- r"""Sorting expression evaluated against nodes"""
16
+ r"""Sorting expression to evaluate against Nodes to specify the sort order for the response."""
17
+ filter_: NotRequired[str]
18
+ r"""JSON-stringified filter object to evaluate against Nodes for inclusion in the response."""
19
+ sort: NotRequired[str]
20
+ r"""JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response."""
19
21
  limit: NotRequired[int]
20
- r"""Maximum number of nodes to return"""
22
+ r"""Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches."""
21
23
  offset: NotRequired[int]
22
- r"""Pagination offset"""
23
- filter_: NotRequired[str]
24
- r"""Filter object (JSON stringified) to select nodes"""
24
+ r"""Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches."""
25
25
 
26
26
 
27
27
  class ListMasterWorkerEntryRequest(BaseModel):
@@ -30,39 +30,39 @@ class ListMasterWorkerEntryRequest(BaseModel):
30
30
  pydantic.Field(alias="filterExp"),
31
31
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
32
32
  ] = None
33
- r"""Filter expression evaluated against nodes"""
33
+ r"""Filter expression to evaluate against Nodes for inclusion in the response."""
34
34
 
35
- sort: Annotated[
35
+ sort_exp: Annotated[
36
36
  Optional[str],
37
+ pydantic.Field(alias="sortExp"),
37
38
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
38
39
  ] = None
39
- r"""Sorting object (JSON stringified) expression evaluated against nodes"""
40
+ r"""Sorting expression to evaluate against Nodes to specify the sort order for the response."""
40
41
 
41
- sort_exp: Annotated[
42
+ filter_: Annotated[
42
43
  Optional[str],
43
- pydantic.Field(alias="sortExp"),
44
+ pydantic.Field(alias="filter"),
44
45
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
45
46
  ] = None
46
- r"""Sorting expression evaluated against nodes"""
47
+ r"""JSON-stringified filter object to evaluate against Nodes for inclusion in the response."""
47
48
 
48
- limit: Annotated[
49
- Optional[int],
49
+ sort: Annotated[
50
+ Optional[str],
50
51
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
51
52
  ] = None
52
- r"""Maximum number of nodes to return"""
53
+ r"""JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response."""
53
54
 
54
- offset: Annotated[
55
+ limit: Annotated[
55
56
  Optional[int],
56
57
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
57
58
  ] = None
58
- r"""Pagination offset"""
59
+ r"""Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches."""
59
60
 
60
- filter_: Annotated[
61
- Optional[str],
62
- pydantic.Field(alias="filter"),
61
+ offset: Annotated[
62
+ Optional[int],
63
63
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
64
64
  ] = None
65
- r"""Filter object (JSON stringified) to select nodes"""
65
+ r"""Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches."""
66
66
 
67
67
 
68
68
  class ListMasterWorkerEntryResponseTypedDict(TypedDict):
@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class UpdateCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
13
13
  lake_id: str
14
- r"""lake id that contains the Datasets"""
14
+ r"""The <code>id</code> of the Lake that contains the Lake Dataset to update."""
15
15
  id_param: str
16
- r"""dataset id to update"""
16
+ r"""The <code>id</code> of the Lake Dataset to update."""
17
17
  cribl_lake_dataset: CriblLakeDatasetTypedDict
18
18
  r"""CriblLakeDataset object"""
19
19
 
@@ -24,14 +24,14 @@ class UpdateCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
24
24
  pydantic.Field(alias="lakeId"),
25
25
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
26
26
  ]
27
- r"""lake id that contains the Datasets"""
27
+ r"""The <code>id</code> of the Lake that contains the Lake Dataset to update."""
28
28
 
29
29
  id_param: Annotated[
30
30
  str,
31
31
  pydantic.Field(alias="id"),
32
32
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
33
33
  ]
34
- r"""dataset id to update"""
34
+ r"""The <code>id</code> of the Lake Dataset to update."""
35
35
 
36
36
  cribl_lake_dataset: Annotated[
37
37
  CriblLakeDataset,
@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class UpdateInputByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""Unique ID to PATCH"""
13
+ r"""The <code>id</code> of the Source to update."""
14
14
  input: InputTypedDict
15
15
  r"""Input object"""
16
16
 
@@ -19,7 +19,7 @@ class UpdateInputByIDRequest(BaseModel):
19
19
  id: Annotated[
20
20
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
21
21
  ]
22
- r"""Unique ID to PATCH"""
22
+ r"""The <code>id</code> of the Source to update."""
23
23
 
24
24
  input: Annotated[
25
25
  Input, FieldMetadata(request=RequestMetadata(media_type="application/json"))
@@ -10,9 +10,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class UpdateInputHecTokenByIDAndTokenRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""HEC Source id"""
13
+ r"""The <code>id</code> of the Splunk HEC Source."""
14
14
  token: str
15
- r"""token to update"""
15
+ r"""The <code>id</code> of the HEC token to update."""
16
16
  update_hec_token_request: UpdateHecTokenRequestTypedDict
17
17
  r"""UpdateHecTokenRequest object"""
18
18
 
@@ -21,12 +21,12 @@ class UpdateInputHecTokenByIDAndTokenRequest(BaseModel):
21
21
  id: Annotated[
22
22
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
23
23
  ]
24
- r"""HEC Source id"""
24
+ r"""The <code>id</code> of the Splunk HEC Source."""
25
25
 
26
26
  token: Annotated[
27
27
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
28
28
  ]
29
- r"""token to update"""
29
+ r"""The <code>id</code> of the HEC token to update."""
30
30
 
31
31
  update_hec_token_request: Annotated[
32
32
  UpdateHecTokenRequest,
@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class UpdateOutputByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""Unique ID to PATCH"""
13
+ r"""The <code>id</code> of the Destination to update."""
14
14
  output: OutputTypedDict
15
15
  r"""Output object"""
16
16
 
@@ -19,7 +19,7 @@ class UpdateOutputByIDRequest(BaseModel):
19
19
  id: Annotated[
20
20
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
21
21
  ]
22
- r"""Unique ID to PATCH"""
22
+ r"""The <code>id</code> of the Destination to update."""
23
23
 
24
24
  output: Annotated[
25
25
  Output, FieldMetadata(request=RequestMetadata(media_type="application/json"))
@@ -14,7 +14,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
14
14
 
15
15
  class UpdatePacksByIDRequestTypedDict(TypedDict):
16
16
  id: str
17
- r"""Pack name"""
17
+ r"""The <code>id</code> of the Pack to upgrade."""
18
18
  source: NotRequired[str]
19
19
  r"""body string required Pack source"""
20
20
  minor: NotRequired[str]
@@ -27,7 +27,7 @@ class UpdatePacksByIDRequest(BaseModel):
27
27
  id: Annotated[
28
28
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
29
29
  ]
30
- r"""Pack name"""
30
+ r"""The <code>id</code> of the Pack to upgrade."""
31
31
 
32
32
  source: Annotated[
33
33
  Optional[str],
@@ -26,26 +26,26 @@ class Nodes(BaseSDK):
26
26
  self,
27
27
  *,
28
28
  filter_exp: Optional[str] = None,
29
- sort: Optional[str] = None,
30
29
  sort_exp: Optional[str] = None,
30
+ filter_: Optional[str] = None,
31
+ sort: Optional[str] = None,
31
32
  limit: Optional[int] = None,
32
33
  offset: Optional[int] = None,
33
- filter_: Optional[str] = None,
34
34
  retries: OptionalNullable[utils.RetryConfig] = UNSET,
35
35
  server_url: Optional[str] = None,
36
36
  timeout_ms: Optional[int] = None,
37
37
  http_headers: Optional[Mapping[str, str]] = None,
38
38
  ) -> models.ListMasterWorkerEntryResponse:
39
- r"""Retrieve detailed metadata for Worker and Edge Nodes
39
+ r"""Get detailed metadata for Worker and Edge Nodes
40
40
 
41
- get worker and edge nodes
41
+ Get detailed metadata for Worker and Edge Nodes.
42
42
 
43
- :param filter_exp: Filter expression evaluated against nodes
44
- :param sort: Sorting object (JSON stringified) expression evaluated against nodes
45
- :param sort_exp: Sorting expression evaluated against nodes
46
- :param limit: Maximum number of nodes to return
47
- :param offset: Pagination offset
48
- :param filter_: Filter object (JSON stringified) to select nodes
43
+ :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
44
+ :param sort_exp: Sorting expression to evaluate against Nodes to specify the sort order for the response.
45
+ :param filter_: JSON-stringified filter object to evaluate against Nodes for inclusion in the response.
46
+ :param sort: JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response.
47
+ :param limit: Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.
48
+ :param offset: Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.
49
49
  :param retries: Override the default retry configuration for this method
50
50
  :param server_url: Override the default server URL for this method
51
51
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -63,11 +63,11 @@ class Nodes(BaseSDK):
63
63
 
64
64
  request = models.ListMasterWorkerEntryRequest(
65
65
  filter_exp=filter_exp,
66
- sort=sort,
67
66
  sort_exp=sort_exp,
67
+ filter_=filter_,
68
+ sort=sort,
68
69
  limit=limit,
69
70
  offset=offset,
70
- filter_=filter_,
71
71
  )
72
72
 
73
73
  req = self._build_request(
@@ -130,26 +130,26 @@ class Nodes(BaseSDK):
130
130
  self,
131
131
  *,
132
132
  filter_exp: Optional[str] = None,
133
- sort: Optional[str] = None,
134
133
  sort_exp: Optional[str] = None,
134
+ filter_: Optional[str] = None,
135
+ sort: Optional[str] = None,
135
136
  limit: Optional[int] = None,
136
137
  offset: Optional[int] = None,
137
- filter_: Optional[str] = None,
138
138
  retries: OptionalNullable[utils.RetryConfig] = UNSET,
139
139
  server_url: Optional[str] = None,
140
140
  timeout_ms: Optional[int] = None,
141
141
  http_headers: Optional[Mapping[str, str]] = None,
142
142
  ) -> models.ListMasterWorkerEntryResponse:
143
- r"""Retrieve detailed metadata for Worker and Edge Nodes
143
+ r"""Get detailed metadata for Worker and Edge Nodes
144
144
 
145
- get worker and edge nodes
145
+ Get detailed metadata for Worker and Edge Nodes.
146
146
 
147
- :param filter_exp: Filter expression evaluated against nodes
148
- :param sort: Sorting object (JSON stringified) expression evaluated against nodes
149
- :param sort_exp: Sorting expression evaluated against nodes
150
- :param limit: Maximum number of nodes to return
151
- :param offset: Pagination offset
152
- :param filter_: Filter object (JSON stringified) to select nodes
147
+ :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
148
+ :param sort_exp: Sorting expression to evaluate against Nodes to specify the sort order for the response.
149
+ :param filter_: JSON-stringified filter object to evaluate against Nodes for inclusion in the response.
150
+ :param sort: JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response.
151
+ :param limit: Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.
152
+ :param offset: Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.
153
153
  :param retries: Override the default retry configuration for this method
154
154
  :param server_url: Override the default server URL for this method
155
155
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -167,11 +167,11 @@ class Nodes(BaseSDK):
167
167
 
168
168
  request = models.ListMasterWorkerEntryRequest(
169
169
  filter_exp=filter_exp,
170
- sort=sort,
171
170
  sort_exp=sort_exp,
171
+ filter_=filter_,
172
+ sort=sort,
172
173
  limit=limit,
173
174
  offset=offset,
174
- filter_=filter_,
175
175
  )
176
176
 
177
177
  req = self._build_request_async(
@@ -239,11 +239,11 @@ class Nodes(BaseSDK):
239
239
  timeout_ms: Optional[int] = None,
240
240
  http_headers: Optional[Mapping[str, str]] = None,
241
241
  ) -> models.GetMasterWorkerEntryResponse:
242
- r"""Retrieve a count of Worker and Edge Nodes
242
+ r"""Get a count of Worker and Edge Nodes
243
243
 
244
- get worker and edge nodes count
244
+ Get a count of all Worker and Edge Nodes.
245
245
 
246
- :param filter_exp: Filter expression evaluated against nodes
246
+ :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
247
247
  :param retries: Override the default retry configuration for this method
248
248
  :param server_url: Override the default server URL for this method
249
249
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -328,11 +328,11 @@ class Nodes(BaseSDK):
328
328
  timeout_ms: Optional[int] = None,
329
329
  http_headers: Optional[Mapping[str, str]] = None,
330
330
  ) -> models.GetMasterWorkerEntryResponse:
331
- r"""Retrieve a count of Worker and Edge Nodes
331
+ r"""Get a count of Worker and Edge Nodes
332
332
 
333
- get worker and edge nodes count
333
+ Get a count of all Worker and Edge Nodes.
334
334
 
335
- :param filter_exp: Filter expression evaluated against nodes
335
+ :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
336
336
  :param retries: Override the default retry configuration for this method
337
337
  :param server_url: Override the default server URL for this method
338
338
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -38,7 +38,7 @@ class Packs(BaseSDK):
38
38
  ) -> models.CreatePacksResponse:
39
39
  r"""Install a Pack
40
40
 
41
- Install Pack
41
+ Install a Pack.
42
42
 
43
43
  :param id:
44
44
  :param source:
@@ -169,7 +169,7 @@ class Packs(BaseSDK):
169
169
  ) -> models.CreatePacksResponse:
170
170
  r"""Install a Pack
171
171
 
172
- Install Pack
172
+ Install a Pack.
173
173
 
174
174
  :param id:
175
175
  :param source:
@@ -285,9 +285,9 @@ class Packs(BaseSDK):
285
285
  ) -> models.GetPacksResponse:
286
286
  r"""List all Packs
287
287
 
288
- Get info on packs
288
+ Get a list of all Packs.
289
289
 
290
- :param with_: Comma separated list of entities, \"outputs\", \"inputs\"
290
+ :param with_: Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>.
291
291
  :param retries: Override the default retry configuration for this method
292
292
  :param server_url: Override the default server URL for this method
293
293
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -372,9 +372,9 @@ class Packs(BaseSDK):
372
372
  ) -> models.GetPacksResponse:
373
373
  r"""List all Packs
374
374
 
375
- Get info on packs
375
+ Get a list of all Packs.
376
376
 
377
- :param with_: Comma separated list of entities, \"outputs\", \"inputs\"
377
+ :param with_: Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>.
378
378
  :param retries: Override the default retry configuration for this method
379
379
  :param server_url: Override the default server URL for this method
380
380
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -459,9 +459,9 @@ class Packs(BaseSDK):
459
459
  ) -> models.DeletePacksByIDResponse:
460
460
  r"""Uninstall a Pack
461
461
 
462
- Uninstall Pack from the system
462
+ Uninstall the specified Pack.
463
463
 
464
- :param id: Pack name
464
+ :param id: The <code>id</code> of the Pack to uninstall.
465
465
  :param retries: Override the default retry configuration for this method
466
466
  :param server_url: Override the default server URL for this method
467
467
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -546,9 +546,9 @@ class Packs(BaseSDK):
546
546
  ) -> models.DeletePacksByIDResponse:
547
547
  r"""Uninstall a Pack
548
548
 
549
- Uninstall Pack from the system
549
+ Uninstall the specified Pack.
550
550
 
551
- :param id: Pack name
551
+ :param id: The <code>id</code> of the Pack to uninstall.
552
552
  :param retries: Override the default retry configuration for this method
553
553
  :param server_url: Override the default server URL for this method
554
554
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -634,11 +634,11 @@ class Packs(BaseSDK):
634
634
  timeout_ms: Optional[int] = None,
635
635
  http_headers: Optional[Mapping[str, str]] = None,
636
636
  ) -> models.UpdatePacksByIDResponse:
637
- r"""Update a Pack
637
+ r"""Upgrade a Pack
638
638
 
639
- Upgrade Pack
639
+ Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
640
640
 
641
- :param id: Pack name
641
+ :param id: The <code>id</code> of the Pack to upgrade.
642
642
  :param source: body string required Pack source
643
643
  :param minor: body boolean optional Only upgrade to minor/patch versions
644
644
  :param spec: body string optional Specify a branch, tag or a semver spec
@@ -730,11 +730,11 @@ class Packs(BaseSDK):
730
730
  timeout_ms: Optional[int] = None,
731
731
  http_headers: Optional[Mapping[str, str]] = None,
732
732
  ) -> models.UpdatePacksByIDResponse:
733
- r"""Update a Pack
733
+ r"""Upgrade a Pack
734
734
 
735
- Upgrade Pack
735
+ Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
736
736
 
737
- :param id: Pack name
737
+ :param id: The <code>id</code> of the Pack to upgrade.
738
738
  :param source: body string required Pack source
739
739
  :param minor: body boolean optional Only upgrade to minor/patch versions
740
740
  :param spec: body string optional Specify a branch, tag or a semver spec
@@ -19,11 +19,11 @@ class Samples(BaseSDK):
19
19
  timeout_ms: Optional[int] = None,
20
20
  http_headers: Optional[Mapping[str, str]] = None,
21
21
  ) -> models.GetOutputSamplesByIDResponse:
22
- r"""Retrieve sample event data for a Destination
22
+ r"""Get sample event data for a Destination
23
23
 
24
- Retrieve samples data for the specified destination. Used to get sample data for the test action.
24
+ Get sample event data for the specified Destination to validate the configuration or test connectivity.
25
25
 
26
- :param id: Destination Id
26
+ :param id: The <code>id</code> of the Destination to get sample event data for.
27
27
  :param retries: Override the default retry configuration for this method
28
28
  :param server_url: Override the default server URL for this method
29
29
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -108,11 +108,11 @@ class Samples(BaseSDK):
108
108
  timeout_ms: Optional[int] = None,
109
109
  http_headers: Optional[Mapping[str, str]] = None,
110
110
  ) -> models.GetOutputSamplesByIDResponse:
111
- r"""Retrieve sample event data for a Destination
111
+ r"""Get sample event data for a Destination
112
112
 
113
- Retrieve samples data for the specified destination. Used to get sample data for the test action.
113
+ Get sample event data for the specified Destination to validate the configuration or test connectivity.
114
114
 
115
- :param id: Destination Id
115
+ :param id: The <code>id</code> of the Destination to get sample event data for.
116
116
  :param retries: Override the default retry configuration for this method
117
117
  :param server_url: Override the default server URL for this method
118
118
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -200,9 +200,9 @@ class Samples(BaseSDK):
200
200
  ) -> models.CreateOutputTestByIDResponse:
201
201
  r"""Send sample event data to a Destination
202
202
 
203
- Send sample data to a destination to validate configuration or test connectivity
203
+ Send sample event data to the specified Destination to validate the configuration or test connectivity.
204
204
 
205
- :param id: Destination Id
205
+ :param id: The <code>id</code> of the Destination to send sample event data to.
206
206
  :param events:
207
207
  :param retries: Override the default retry configuration for this method
208
208
  :param server_url: Override the default server URL for this method
@@ -301,9 +301,9 @@ class Samples(BaseSDK):
301
301
  ) -> models.CreateOutputTestByIDResponse:
302
302
  r"""Send sample event data to a Destination
303
303
 
304
- Send sample data to a destination to validate configuration or test connectivity
304
+ Send sample event data to the specified Destination to validate the configuration or test connectivity.
305
305
 
306
- :param id: Destination Id
306
+ :param id: The <code>id</code> of the Destination to send sample event data to.
307
307
  :param events:
308
308
  :param retries: Override the default retry configuration for this method
309
309
  :param server_url: Override the default server URL for this method