v1

package
v0.0.1-alpha.100 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 25, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type File 

type File struct {
	// Textual Content.
	Content string `pulumi:"content"`
	// Fingerprint (e.g. github sha) associated with the `File`.
	Fingerprint *string `pulumi:"fingerprint"`
	// File name.
	Name string `pulumi:"name"`
}

`File` containing source content.

type FileArgs 

type FileArgs struct {
	// Textual Content.
	Content pulumi.StringInput `pulumi:"content"`
	// Fingerprint (e.g. github sha) associated with the `File`.
	Fingerprint pulumi.StringPtrInput `pulumi:"fingerprint"`
	// File name.
	Name pulumi.StringInput `pulumi:"name"`
}

`File` containing source content.

func (FileArgs) ElementType 

func (FileArgs) ElementType() reflect.Type

func (FileArgs) ToFileOutput 

func (i FileArgs) ToFileOutput() FileOutput

func (FileArgs) ToFileOutputWithContext 

func (i FileArgs) ToFileOutputWithContext(ctx context.Context) FileOutput

type FileArray 

type FileArray []FileInput

func (FileArray) ElementType 

func (FileArray) ElementType() reflect.Type

func (FileArray) ToFileArrayOutput 

func (i FileArray) ToFileArrayOutput() FileArrayOutput

func (FileArray) ToFileArrayOutputWithContext 

func (i FileArray) ToFileArrayOutputWithContext(ctx context.Context) FileArrayOutput

type FileArrayInput 

type FileArrayInput interface {
	pulumi.Input

	ToFileArrayOutput() FileArrayOutput
	ToFileArrayOutputWithContext(context.Context) FileArrayOutput
}

FileArrayInput is an input type that accepts FileArray and FileArrayOutput values. You can construct a concrete instance of `FileArrayInput` via: 

FileArray{ FileArgs{...} }

type FileArrayOutput 

type FileArrayOutput struct{ *pulumi.OutputState }

func (FileArrayOutput) ElementType 

func (FileArrayOutput) ElementType() reflect.Type

func (FileArrayOutput) Index 

func (o FileArrayOutput) Index(i pulumi.IntInput) FileOutput

func (FileArrayOutput) ToFileArrayOutput 

func (o FileArrayOutput) ToFileArrayOutput() FileArrayOutput

func (FileArrayOutput) ToFileArrayOutputWithContext 

func (o FileArrayOutput) ToFileArrayOutputWithContext(ctx context.Context) FileArrayOutput

type FileInput 

type FileInput interface {
	pulumi.Input

	ToFileOutput() FileOutput
	ToFileOutputWithContext(context.Context) FileOutput
}

FileInput is an input type that accepts FileArgs and FileOutput values. You can construct a concrete instance of `FileInput` via: 

FileArgs{...}

type FileOutput 

type FileOutput struct{ *pulumi.OutputState }

`File` containing source content.

func (FileOutput) Content 

func (o FileOutput) Content() pulumi.StringOutput

Textual Content.

func (FileOutput) ElementType 

func (FileOutput) ElementType() reflect.Type

func (FileOutput) Fingerprint 

func (o FileOutput) Fingerprint() pulumi.StringPtrOutput

Fingerprint (e.g. github sha) associated with the `File`.

func (FileOutput) Name 

func (o FileOutput) Name() pulumi.StringOutput

File name.

func (FileOutput) ToFileOutput 

func (o FileOutput) ToFileOutput() FileOutput

func (FileOutput) ToFileOutputWithContext 

func (o FileOutput) ToFileOutputWithContext(ctx context.Context) FileOutput

type FileResponse 

type FileResponse struct {
	// Textual Content.
	Content string `pulumi:"content"`
	// Fingerprint (e.g. github sha) associated with the `File`.
	Fingerprint string `pulumi:"fingerprint"`
	// File name.
	Name string `pulumi:"name"`
}

`File` containing source content.

type FileResponseArrayOutput 

type FileResponseArrayOutput struct{ *pulumi.OutputState }

func (FileResponseArrayOutput) ElementType 

func (FileResponseArrayOutput) ElementType() reflect.Type

func (FileResponseArrayOutput) Index 

func (o FileResponseArrayOutput) Index(i pulumi.IntInput) FileResponseOutput

func (FileResponseArrayOutput) ToFileResponseArrayOutput 

func (o FileResponseArrayOutput) ToFileResponseArrayOutput() FileResponseArrayOutput

func (FileResponseArrayOutput) ToFileResponseArrayOutputWithContext 

func (o FileResponseArrayOutput) ToFileResponseArrayOutputWithContext(ctx context.Context) FileResponseArrayOutput

type FileResponseOutput 

type FileResponseOutput struct{ *pulumi.OutputState }

`File` containing source content.

func (FileResponseOutput) Content 

func (o FileResponseOutput) Content() pulumi.StringOutput

Textual Content.

func (FileResponseOutput) ElementType 

func (FileResponseOutput) ElementType() reflect.Type

func (FileResponseOutput) Fingerprint 

func (o FileResponseOutput) Fingerprint() pulumi.StringOutput

Fingerprint (e.g. github sha) associated with the `File`.

func (FileResponseOutput) Name 

func (o FileResponseOutput) Name() pulumi.StringOutput

File name.

func (FileResponseOutput) ToFileResponseOutput 

func (o FileResponseOutput) ToFileResponseOutput() FileResponseOutput

func (FileResponseOutput) ToFileResponseOutputWithContext 

func (o FileResponseOutput) ToFileResponseOutputWithContext(ctx context.Context) FileResponseOutput

type LookupReleaseArgs added in v0.4.0 

type LookupReleaseArgs struct {
	Project   *string `pulumi:"project"`
	ReleaseId string  `pulumi:"releaseId"`
}

type LookupReleaseOutputArgs added in v0.8.0 

type LookupReleaseOutputArgs struct {
	Project   pulumi.StringPtrInput `pulumi:"project"`
	ReleaseId pulumi.StringInput    `pulumi:"releaseId"`
}

func (LookupReleaseOutputArgs) ElementType added in v0.8.0 

func (LookupReleaseOutputArgs) ElementType() reflect.Type

type LookupReleaseResult added in v0.4.0 

type LookupReleaseResult struct {
	// Time the release was created.
	CreateTime string `pulumi:"createTime"`
	// Format: `projects/{project_id}/releases/{release_id}`
	Name string `pulumi:"name"`
	// Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist for the `Release` to be created.
	RulesetName string `pulumi:"rulesetName"`
	// Time the release was updated.
	UpdateTime string `pulumi:"updateTime"`
}

func LookupRelease added in v0.4.0 

func LookupRelease(ctx *pulumi.Context, args *LookupReleaseArgs, opts ...pulumi.InvokeOption) (*LookupReleaseResult, error)

Get a `Release` by name.

type LookupReleaseResultOutput added in v0.8.0 

type LookupReleaseResultOutput struct{ *pulumi.OutputState }

func LookupReleaseOutput added in v0.8.0 

func LookupReleaseOutput(ctx *pulumi.Context, args LookupReleaseOutputArgs, opts ...pulumi.InvokeOption) LookupReleaseResultOutput

func (LookupReleaseResultOutput) CreateTime added in v0.8.0 

func (o LookupReleaseResultOutput) CreateTime() pulumi.StringOutput

Time the release was created.

func (LookupReleaseResultOutput) ElementType added in v0.8.0 

func (LookupReleaseResultOutput) ElementType() reflect.Type

func (LookupReleaseResultOutput) Name added in v0.8.0 

func (o LookupReleaseResultOutput) Name() pulumi.StringOutput

Format: `projects/{project_id}/releases/{release_id}`

func (LookupReleaseResultOutput) RulesetName added in v0.8.0 

func (o LookupReleaseResultOutput) RulesetName() pulumi.StringOutput

Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist for the `Release` to be created.

func (LookupReleaseResultOutput) ToLookupReleaseResultOutput added in v0.8.0 

func (o LookupReleaseResultOutput) ToLookupReleaseResultOutput() LookupReleaseResultOutput

func (LookupReleaseResultOutput) ToLookupReleaseResultOutputWithContext added in v0.8.0 

func (o LookupReleaseResultOutput) ToLookupReleaseResultOutputWithContext(ctx context.Context) LookupReleaseResultOutput

func (LookupReleaseResultOutput) UpdateTime added in v0.8.0 

func (o LookupReleaseResultOutput) UpdateTime() pulumi.StringOutput

Time the release was updated.

type LookupRulesetArgs added in v0.4.0 

type LookupRulesetArgs struct {
	Project   *string `pulumi:"project"`
	RulesetId string  `pulumi:"rulesetId"`
}

type LookupRulesetOutputArgs added in v0.8.0 

type LookupRulesetOutputArgs struct {
	Project   pulumi.StringPtrInput `pulumi:"project"`
	RulesetId pulumi.StringInput    `pulumi:"rulesetId"`
}

func (LookupRulesetOutputArgs) ElementType added in v0.8.0 

func (LookupRulesetOutputArgs) ElementType() reflect.Type

type LookupRulesetResult added in v0.4.0 

type LookupRulesetResult struct {
	// Time the `Ruleset` was created.
	CreateTime string `pulumi:"createTime"`
	// The metadata for this ruleset.
	Metadata MetadataResponse `pulumi:"metadata"`
	// Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
	Name string `pulumi:"name"`
	// `Source` for the `Ruleset`.
	Source SourceResponse `pulumi:"source"`
}

func LookupRuleset added in v0.4.0 

func LookupRuleset(ctx *pulumi.Context, args *LookupRulesetArgs, opts ...pulumi.InvokeOption) (*LookupRulesetResult, error)

Get a `Ruleset` by name including the full `Source` contents.

type LookupRulesetResultOutput added in v0.8.0 

type LookupRulesetResultOutput struct{ *pulumi.OutputState }

func LookupRulesetOutput added in v0.8.0 

func LookupRulesetOutput(ctx *pulumi.Context, args LookupRulesetOutputArgs, opts ...pulumi.InvokeOption) LookupRulesetResultOutput

func (LookupRulesetResultOutput) CreateTime added in v0.8.0 

func (o LookupRulesetResultOutput) CreateTime() pulumi.StringOutput

Time the `Ruleset` was created.

func (LookupRulesetResultOutput) ElementType added in v0.8.0 

func (LookupRulesetResultOutput) ElementType() reflect.Type

func (LookupRulesetResultOutput) Metadata added in v0.8.0 

func (o LookupRulesetResultOutput) Metadata() MetadataResponseOutput

The metadata for this ruleset.

func (LookupRulesetResultOutput) Name added in v0.8.0 

func (o LookupRulesetResultOutput) Name() pulumi.StringOutput

Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`

func (LookupRulesetResultOutput) Source added in v0.8.0 

func (o LookupRulesetResultOutput) Source() SourceResponseOutput

`Source` for the `Ruleset`.

func (LookupRulesetResultOutput) ToLookupRulesetResultOutput added in v0.8.0 

func (o LookupRulesetResultOutput) ToLookupRulesetResultOutput() LookupRulesetResultOutput

func (LookupRulesetResultOutput) ToLookupRulesetResultOutputWithContext added in v0.8.0 

func (o LookupRulesetResultOutput) ToLookupRulesetResultOutputWithContext(ctx context.Context) LookupRulesetResultOutput

type MetadataResponse 

type MetadataResponse struct {
	// Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
	Services []string `pulumi:"services"`
}

Metadata for a Ruleset.

type MetadataResponseOutput 

type MetadataResponseOutput struct{ *pulumi.OutputState }

Metadata for a Ruleset.

func (MetadataResponseOutput) ElementType 

func (MetadataResponseOutput) ElementType() reflect.Type

func (MetadataResponseOutput) Services 

func (o MetadataResponseOutput) Services() pulumi.StringArrayOutput

Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.

func (MetadataResponseOutput) ToMetadataResponseOutput 

func (o MetadataResponseOutput) ToMetadataResponseOutput() MetadataResponseOutput

func (MetadataResponseOutput) ToMetadataResponseOutputWithContext 

func (o MetadataResponseOutput) ToMetadataResponseOutputWithContext(ctx context.Context) MetadataResponseOutput

type Release 

type Release struct {
	pulumi.CustomResourceState

	// Time the release was created.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// Format: `projects/{project_id}/releases/{release_id}`
	Name    pulumi.StringOutput `pulumi:"name"`
	Project pulumi.StringOutput `pulumi:"project"`
	// Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist for the `Release` to be created.
	RulesetName pulumi.StringOutput `pulumi:"rulesetName"`
	// Time the release was updated.
	UpdateTime pulumi.StringOutput `pulumi:"updateTime"`
}

Create a `Release`. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a `Release` refers to a `Ruleset`, the rules can be enforced by Firebase Rules-enabled services. More than one `Release` may be 'live' concurrently. Consider the following three `Release` names for `projects/foo` and the `Ruleset` to which they refer. Release Name -> Ruleset Name * projects/foo/releases/prod -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/beta -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/v23 -> projects/foo/rulesets/uuid456 The relationships reflect a `Ruleset` rollout in progress. The `prod` and `prod/beta` releases refer to the same `Ruleset`. However, `prod/v23` refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be updated using the UpdateRelease method.

func GetRelease 

func GetRelease(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ReleaseState, opts ...pulumi.ResourceOption) (*Release, error)

GetRelease gets an existing Release resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRelease 

func NewRelease(ctx *pulumi.Context,
	name string, args *ReleaseArgs, opts ...pulumi.ResourceOption) (*Release, error)

NewRelease registers a new resource with the given unique name, arguments, and options.

func (*Release) ElementType 

func (*Release) ElementType() reflect.Type

func (*Release) ToReleaseOutput 

func (i *Release) ToReleaseOutput() ReleaseOutput

func (*Release) ToReleaseOutputWithContext 

func (i *Release) ToReleaseOutputWithContext(ctx context.Context) ReleaseOutput

type ReleaseArgs 

type ReleaseArgs struct {
	// Format: `projects/{project_id}/releases/{release_id}`
	Name    pulumi.StringPtrInput
	Project pulumi.StringPtrInput
	// Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist for the `Release` to be created.
	RulesetName pulumi.StringInput
}

The set of arguments for constructing a Release resource.

func (ReleaseArgs) ElementType 

func (ReleaseArgs) ElementType() reflect.Type

type ReleaseInput 

type ReleaseInput interface {
	pulumi.Input

	ToReleaseOutput() ReleaseOutput
	ToReleaseOutputWithContext(ctx context.Context) ReleaseOutput
}

type ReleaseOutput 

type ReleaseOutput struct{ *pulumi.OutputState }

func (ReleaseOutput) CreateTime added in v0.19.0 

func (o ReleaseOutput) CreateTime() pulumi.StringOutput

Time the release was created.

func (ReleaseOutput) ElementType 

func (ReleaseOutput) ElementType() reflect.Type

func (ReleaseOutput) Name added in v0.19.0 

func (o ReleaseOutput) Name() pulumi.StringOutput

Format: `projects/{project_id}/releases/{release_id}`

func (ReleaseOutput) Project added in v0.21.0 

func (o ReleaseOutput) Project() pulumi.StringOutput

func (ReleaseOutput) RulesetName added in v0.19.0 

func (o ReleaseOutput) RulesetName() pulumi.StringOutput

Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist for the `Release` to be created.

func (ReleaseOutput) ToReleaseOutput 

func (o ReleaseOutput) ToReleaseOutput() ReleaseOutput

func (ReleaseOutput) ToReleaseOutputWithContext 

func (o ReleaseOutput) ToReleaseOutputWithContext(ctx context.Context) ReleaseOutput

func (ReleaseOutput) UpdateTime added in v0.19.0 

func (o ReleaseOutput) UpdateTime() pulumi.StringOutput

Time the release was updated.

type ReleaseState 

type ReleaseState struct {
}

func (ReleaseState) ElementType 

func (ReleaseState) ElementType() reflect.Type

type Ruleset 

type Ruleset struct {
	pulumi.CustomResourceState

	// Time the `Ruleset` was created.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// The metadata for this ruleset.
	Metadata MetadataResponseOutput `pulumi:"metadata"`
	// Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`
	Name    pulumi.StringOutput `pulumi:"name"`
	Project pulumi.StringOutput `pulumi:"project"`
	// `Source` for the `Ruleset`.
	Source SourceResponseOutput `pulumi:"source"`
}

Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset. Auto-naming is currently not supported for this resource.

func GetRuleset 

func GetRuleset(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RulesetState, opts ...pulumi.ResourceOption) (*Ruleset, error)

GetRuleset gets an existing Ruleset resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRuleset 

func NewRuleset(ctx *pulumi.Context,
	name string, args *RulesetArgs, opts ...pulumi.ResourceOption) (*Ruleset, error)

NewRuleset registers a new resource with the given unique name, arguments, and options.

func (*Ruleset) ElementType 

func (*Ruleset) ElementType() reflect.Type

func (*Ruleset) ToRulesetOutput 

func (i *Ruleset) ToRulesetOutput() RulesetOutput

func (*Ruleset) ToRulesetOutputWithContext 

func (i *Ruleset) ToRulesetOutputWithContext(ctx context.Context) RulesetOutput

type RulesetArgs 

type RulesetArgs struct {
	Project pulumi.StringPtrInput
	// `Source` for the `Ruleset`.
	Source SourceInput
}

The set of arguments for constructing a Ruleset resource.

func (RulesetArgs) ElementType 

func (RulesetArgs) ElementType() reflect.Type

type RulesetInput 

type RulesetInput interface {
	pulumi.Input

	ToRulesetOutput() RulesetOutput
	ToRulesetOutputWithContext(ctx context.Context) RulesetOutput
}

type RulesetOutput 

type RulesetOutput struct{ *pulumi.OutputState }

func (RulesetOutput) CreateTime added in v0.19.0 

func (o RulesetOutput) CreateTime() pulumi.StringOutput

Time the `Ruleset` was created.

func (RulesetOutput) ElementType 

func (RulesetOutput) ElementType() reflect.Type

func (RulesetOutput) Metadata added in v0.19.0 

func (o RulesetOutput) Metadata() MetadataResponseOutput

The metadata for this ruleset.

func (RulesetOutput) Name added in v0.19.0 

func (o RulesetOutput) Name() pulumi.StringOutput

Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}`

func (RulesetOutput) Project added in v0.21.0 

func (o RulesetOutput) Project() pulumi.StringOutput

func (RulesetOutput) Source added in v0.19.0 

func (o RulesetOutput) Source() SourceResponseOutput

`Source` for the `Ruleset`.

func (RulesetOutput) ToRulesetOutput 

func (o RulesetOutput) ToRulesetOutput() RulesetOutput

func (RulesetOutput) ToRulesetOutputWithContext 

func (o RulesetOutput) ToRulesetOutputWithContext(ctx context.Context) RulesetOutput

type RulesetState 

type RulesetState struct {
}

func (RulesetState) ElementType 

func (RulesetState) ElementType() reflect.Type

type Source 

type Source struct {
	// `File` set constituting the `Source` bundle.
	Files []File `pulumi:"files"`
}

`Source` is one or more `File` messages comprising a logical set of rules.

type SourceArgs 

type SourceArgs struct {
	// `File` set constituting the `Source` bundle.
	Files FileArrayInput `pulumi:"files"`
}

`Source` is one or more `File` messages comprising a logical set of rules.

func (SourceArgs) ElementType 

func (SourceArgs) ElementType() reflect.Type

func (SourceArgs) ToSourceOutput 

func (i SourceArgs) ToSourceOutput() SourceOutput

func (SourceArgs) ToSourceOutputWithContext 

func (i SourceArgs) ToSourceOutputWithContext(ctx context.Context) SourceOutput

type SourceInput 

type SourceInput interface {
	pulumi.Input

	ToSourceOutput() SourceOutput
	ToSourceOutputWithContext(context.Context) SourceOutput
}

SourceInput is an input type that accepts SourceArgs and SourceOutput values. You can construct a concrete instance of `SourceInput` via: 

SourceArgs{...}

type SourceOutput 

type SourceOutput struct{ *pulumi.OutputState }

`Source` is one or more `File` messages comprising a logical set of rules.

func (SourceOutput) ElementType 

func (SourceOutput) ElementType() reflect.Type

func (SourceOutput) Files 

func (o SourceOutput) Files() FileArrayOutput

`File` set constituting the `Source` bundle.

func (SourceOutput) ToSourceOutput 

func (o SourceOutput) ToSourceOutput() SourceOutput

func (SourceOutput) ToSourceOutputWithContext 

func (o SourceOutput) ToSourceOutputWithContext(ctx context.Context) SourceOutput

type SourceResponse 

type SourceResponse struct {
	// `File` set constituting the `Source` bundle.
	Files []FileResponse `pulumi:"files"`
}

`Source` is one or more `File` messages comprising a logical set of rules.

type SourceResponseOutput 

type SourceResponseOutput struct{ *pulumi.OutputState }

`Source` is one or more `File` messages comprising a logical set of rules.

func (SourceResponseOutput) ElementType 

func (SourceResponseOutput) ElementType() reflect.Type

func (SourceResponseOutput) Files 

func (o SourceResponseOutput) Files() FileResponseArrayOutput

`File` set constituting the `Source` bundle.

func (SourceResponseOutput) ToSourceResponseOutput 

func (o SourceResponseOutput) ToSourceResponseOutput() SourceResponseOutput

func (SourceResponseOutput) ToSourceResponseOutputWithContext 

func (o SourceResponseOutput) ToSourceResponseOutputWithContext(ctx context.Context) SourceResponseOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.