Documentation
¶
Index ¶
- Variables
- func FolderModelToCLI(state *FolderModel) *cli.Folder
- func FolderSchema() map[string]schema.Attribute
- func FolderToPortRequest(fm *FolderModel) (*cli.Folder, error)
- func NewFolderResource() resource.Resource
- type FolderModel
- type FolderResource
- func (r *FolderResource) Configure(ctx context.Context, req resource.ConfigureRequest, ...)
- func (r *FolderResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)
- func (r *FolderResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)
- func (r *FolderResource) ImportState(ctx context.Context, req resource.ImportStateRequest, ...)
- func (r *FolderResource) Metadata(ctx context.Context, req resource.MetadataRequest, ...)
- func (r *FolderResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)
- func (r *FolderResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)
- func (r *FolderResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)
- func (r *FolderResource) ValidateConfig(ctx context.Context, req resource.ValidateConfigRequest, ...)
Constants ¶
This section is empty.
Variables ¶
View Source
var FolderResourceMarkdownDescription = `
# Folder resource
A full list of the available folder types and their identifiers can be found [here](https://docs.getport.io/customize-pages-dashboards-and-plugins/folder/catalog-folder).
~> **WARNING**
The folder resource is currently in beta and is subject to change in future versions.
Use it by setting the Environment Variable ` + "`PORT_BETA_FEATURES_ENABLED=true`" + `.
If this Environment Variable isn't specified, you won't be able to use the resource.
## Example Usage
### Basic Folder
` + "```hcl" + `
resource "port_folder" "example_folder" {
identifier = "example_folder"
title = "Example Folder"
}
` + "```" + `
### Folder with Parent
Create a folder inside another folder.
` + "```hcl" + `
resource "port_folder" "child_folder" {
identifier = "child_folder"
parent = port_folder.example_folder.identifier
title = "Child Folder"
}
` + "```" + `
### Folder with After
Create a folder after another folder.
` + "```hcl" + `
resource "port_folder" "another_folder" {
identifier = "another_folder"
after = port_folder.example_folder.identifier
title = "Another Folder"
}
` + "```" + `
`
Functions ¶
func FolderModelToCLI ¶
func FolderModelToCLI(state *FolderModel) *cli.Folder
func FolderSchema ¶
func FolderToPortRequest ¶
func FolderToPortRequest(fm *FolderModel) (*cli.Folder, error)
func NewFolderResource ¶
Types ¶
type FolderModel ¶
type FolderResource ¶
type FolderResource struct {
// contains filtered or unexported fields
}
func (*FolderResource) Configure ¶
func (r *FolderResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)
func (*FolderResource) Create ¶
func (r *FolderResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)
func (*FolderResource) Delete ¶
func (r *FolderResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)
func (*FolderResource) ImportState ¶
func (r *FolderResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)
func (*FolderResource) Metadata ¶
func (r *FolderResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)
func (*FolderResource) Read ¶
func (r *FolderResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)
func (*FolderResource) Schema ¶
func (r *FolderResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)
func (*FolderResource) Update ¶
func (r *FolderResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)
func (*FolderResource) ValidateConfig ¶
func (r *FolderResource) ValidateConfig(ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse)
Click to show internal directories.
Click to hide internal directories.