Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
.. _atlas-dataLakePipelines-availableSchedules-list:

===============================================
atlas dataLakePipelines availableSchedules list
===============================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Return all available schedules for the specified data lake pipeline.

To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.

Syntax
------

.. code-block::
:caption: Command Syntax

atlas dataLakePipelines availableSchedules list [options]

.. Code end marker, please don't delete this comment

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -h, --help
-
- false
- help for list
* - -o, --output
- string
- false
- Output format. Valid values are json, json-path, go-template, or go-template-file.
* - --pipeline
- string
- true
- Name of the Data lake pipeline.
* - --projectId
- string
- false
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.

Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Examples
--------

.. code-block::

# list available schedules for data lake pipeline called 'Pipeline1':
atlas dataLakePipelines availableSchedules list Pipeline1

Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.. _atlas-dataLakePipelines-availableSchedules:

==========================================
atlas dataLakePipelines availableSchedules
==========================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Manage available schedules for the specified data lake pipeline.

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -h, --help
-
- false
- help for availableSchedules

Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Related Commands
----------------

* :ref:`atlas-dataLakePipelines-availableSchedules-list` - Return all available schedules for the specified data lake pipeline.


.. toctree::
:titlesonly:

list </command/atlas-dataLakePipelines-availableSchedules-list>

Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
.. _atlas-dataLakePipelines-availableSnapshots-list:

===============================================
atlas dataLakePipelines availableSnapshots list
===============================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Return all available backup snapshots for the specified data lake pipeline.

To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.

Syntax
------

.. code-block::
:caption: Command Syntax

atlas dataLakePipelines availableSnapshots list [options]

.. Code end marker, please don't delete this comment

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - --completedAfter
- string
- false
- Date filter of which the backup snapshots where completed. Format must be YYYY-MM-DD
* - -h, --help
-
- false
- help for list
* - --limit
- int
- false
- Number of items per results page. This value defaults to 100.
* - -o, --output
- string
- false
- Output format. Valid values are json, json-path, go-template, or go-template-file.
* - --page
- int
- false
- Page number that specifies a page of results. This value defaults to 1.
* - --pipeline
- string
- true
- Name of the Data lake pipeline.
* - --projectId
- string
- false
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.

Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Examples
--------

.. code-block::

# list available backup schedules for data lake pipeline called 'Pipeline1':
atlas dataLakePipelines availableSnapshots list Pipeline1

Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.. _atlas-dataLakePipelines-availableSnapshots:

==========================================
atlas dataLakePipelines availableSnapshots
==========================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Manage available backup snapshots for data lake pipelines.

Options
-------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -h, --help
-
- false
- help for availableSnapshots

Inherited Options
-----------------

.. list-table::
:header-rows: 1
:widths: 20 10 10 60

* - Name
- Type
- Required
- Description
* - -P, --profile
- string
- false
- Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Related Commands
----------------

* :ref:`atlas-dataLakePipelines-availableSnapshots-list` - Return all available backup snapshots for the specified data lake pipeline.


.. toctree::
:titlesonly:

list </command/atlas-dataLakePipelines-availableSnapshots-list>

4 changes: 4 additions & 0 deletions docs/atlascli/command/atlas-dataLakePipelines.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ Inherited Options
Related Commands
----------------

* :ref:`atlas-dataLakePipelines-availableSchedules` - Manage available schedules for the specified data lake pipeline.
* :ref:`atlas-dataLakePipelines-availableSnapshots` - Manage available backup snapshots for data lake pipelines.
* :ref:`atlas-dataLakePipelines-create` - Creates a new Data Lake Pipeline.
* :ref:`atlas-dataLakePipelines-delete` - Remove the specified data lake pipeline from your project.
* :ref:`atlas-dataLakePipelines-describe` - Return the details for the specified data lake pipeline for your project.
Expand All @@ -60,6 +62,8 @@ Related Commands
.. toctree::
:titlesonly:

availableSchedules </command/atlas-dataLakePipelines-availableSchedules>
availableSnapshots </command/atlas-dataLakePipelines-availableSnapshots>
create </command/atlas-dataLakePipelines-create>
delete </command/atlas-dataLakePipelines-delete>
describe </command/atlas-dataLakePipelines-describe>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Copyright 2023 MongoDB Inc
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// This code was autogenerated at 2023-04-27T17:56:11+01:00. Note: Manual updates are allowed, but may be overwritten.

package availableschedules

import (
"github.com/mongodb/mongodb-atlas-cli/internal/cli"
"github.com/spf13/cobra"
)

func Builder() *cobra.Command {
const use = "availableSchedules"
cmd := &cobra.Command{
Use: use,
Aliases: cli.GenerateAliases(use),
Short: "Manage available schedules for the specified data lake pipeline.",
}

cmd.AddCommand(
ListBuilder(),
)

return cmd
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright 2023 MongoDB Inc
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:build unit

// This code was autogenerated at 2023-04-27T17:56:11+01:00. Note: Manual updates are allowed, but may be overwritten.

package availableschedules

import (
"testing"

"github.com/mongodb/mongodb-atlas-cli/internal/test"
)

func TestBuilder(t *testing.T) {
test.CmdValidator(
t,
Builder(),
1,
[]string{},
)
}
Loading