github.com/containerd/nerdctl@v1.7.7/pkg/api/types/system_types.go (about)

     1  /*
     2     Copyright The containerd Authors.
     3  
     4     Licensed under the Apache License, Version 2.0 (the "License");
     5     you may not use this file except in compliance with the License.
     6     You may obtain a copy of the License at
     7  
     8         http://www.apache.org/licenses/LICENSE-2.0
     9  
    10     Unless required by applicable law or agreed to in writing, software
    11     distributed under the License is distributed on an "AS IS" BASIS,
    12     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13     See the License for the specific language governing permissions and
    14     limitations under the License.
    15  */
    16  
    17  package types
    18  
    19  import "io"
    20  
    21  // SystemInfoOptions specifies options for `nerdctl (system) info`.
    22  type SystemInfoOptions struct {
    23  	Stdout io.Writer
    24  	Stderr io.Writer
    25  	// GOptions is the global options
    26  	GOptions GlobalCommandOptions
    27  	// Information mode, "dockercompat" for Docker-compatible output, "native" for containerd-native output
    28  	Mode string
    29  	// Format the output using the given Go template, e.g, '{{json .}}
    30  	Format string
    31  }
    32  
    33  // SystemEventsOptions specifies options for `nerdctl (system) events`.
    34  type SystemEventsOptions struct {
    35  	Stdout io.Writer
    36  	// GOptions is the global options
    37  	GOptions GlobalCommandOptions
    38  	// Format the output using the given Go template, e.g, '{{json .}}
    39  	Format string
    40  	// Filter events based on given conditions
    41  	Filters []string
    42  }
    43  
    44  // SystemPruneOptions specifies options for `nerdctl system prune`.
    45  type SystemPruneOptions struct {
    46  	Stdout io.Writer
    47  	Stderr io.Writer
    48  	// GOptions is the global options
    49  	GOptions GlobalCommandOptions
    50  	// All remove all unused images, not just dangling ones
    51  	All bool
    52  	// Volumes decide whether prune volumes or not
    53  	Volumes bool
    54  	// BuildKitHost the address of BuildKit host
    55  	BuildKitHost string
    56  	// NetworkDriversToKeep the network drivers which need to keep
    57  	NetworkDriversToKeep []string
    58  }