api

Documentation

Index

• Variables
• type AuthorizationConfig
  • func (*AuthorizationConfig) Descriptor() ([]byte, []int)
  • func (m *AuthorizationConfig) GetProvider() string
  • func (*AuthorizationConfig) ProtoMessage()
  • func (m *AuthorizationConfig) Reset()
  • func (m *AuthorizationConfig) String() string
  • func (m *AuthorizationConfig) XXX_DiscardUnknown()
  • func (m *AuthorizationConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *AuthorizationConfig) XXX_Merge(src proto.Message)
  • func (m *AuthorizationConfig) XXX_Size() int
  • func (m *AuthorizationConfig) XXX_Unmarshal(b []byte) error
• type Experimental
  • func (*Experimental) Descriptor() ([]byte, []int)
  • func (m *Experimental) GetAuthorization() *AuthorizationConfig
  • func (*Experimental) ProtoMessage()
  • func (m *Experimental) Reset()
  • func (m *Experimental) String() string
  • func (m *Experimental) XXX_DiscardUnknown()
  • func (m *Experimental) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Experimental) XXX_Merge(src proto.Message)
  • func (m *Experimental) XXX_Size() int
  • func (m *Experimental) XXX_Unmarshal(b []byte) error
• type LaunchStage
  • func (LaunchStage) EnumDescriptor() ([]byte, []int)
  • func (x LaunchStage) String() string

Variables

var LaunchStage_name = map[int32]string{
	0: "LAUNCH_STAGE_UNSPECIFIED",
	1: "EARLY_ACCESS",
	2: "ALPHA",
	3: "BETA",
	4: "GA",
	5: "DEPRECATED",
}

var LaunchStage_value = map[string]int32{
	"LAUNCH_STAGE_UNSPECIFIED": 0,
	"EARLY_ACCESS":             1,
	"ALPHA":                    2,
	"BETA":                     3,
	"GA":                       4,
	"DEPRECATED":               5,
}

Types

type AuthorizationConfig

type AuthorizationConfig struct {
	// The name of the authorization provider, such as
	// firebaserules.googleapis.com.
	Provider             string   `protobuf:"bytes,1,opt,name=provider,proto3" json:"provider,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Configuration of authorization.

This section determines the authorization provider, if unspecified, then no authorization check will be done.

Example:

experimental:
  authorization:
    provider: firebaserules.googleapis.com

func (*AuthorizationConfig) Descriptor

func (*AuthorizationConfig) Descriptor() ([]byte, []int)

func (*AuthorizationConfig) GetProvider

func (m *AuthorizationConfig) GetProvider() string

func (*AuthorizationConfig) ProtoMessage

func (*AuthorizationConfig) ProtoMessage()

func (*AuthorizationConfig) Reset

func (m *AuthorizationConfig) Reset()

func (*AuthorizationConfig) String

func (m *AuthorizationConfig) String() string

func (*AuthorizationConfig) XXX_DiscardUnknown

func (m *AuthorizationConfig) XXX_DiscardUnknown()

func (*AuthorizationConfig) XXX_Marshal

func (m *AuthorizationConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AuthorizationConfig) XXX_Merge

func (m *AuthorizationConfig) XXX_Merge(src proto.Message)

func (*AuthorizationConfig) XXX_Size

func (m *AuthorizationConfig) XXX_Size() int

func (*AuthorizationConfig) XXX_Unmarshal

func (m *AuthorizationConfig) XXX_Unmarshal(b []byte) error

type Experimental

type Experimental struct {
	// Authorization configuration.
	Authorization        *AuthorizationConfig `protobuf:"bytes,8,opt,name=authorization,proto3" json:"authorization,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

Experimental service configuration. These configuration options can only be used by whitelisted users.

func (*Experimental) Descriptor

func (*Experimental) Descriptor() ([]byte, []int)

func (*Experimental) GetAuthorization

func (m *Experimental) GetAuthorization() *AuthorizationConfig

func (*Experimental) ProtoMessage

func (*Experimental) ProtoMessage()

func (*Experimental) Reset

func (m *Experimental) Reset()

func (*Experimental) String

func (m *Experimental) String() string

func (*Experimental) XXX_DiscardUnknown

func (m *Experimental) XXX_DiscardUnknown()

func (*Experimental) XXX_Marshal

func (m *Experimental) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Experimental) XXX_Merge

func (m *Experimental) XXX_Merge(src proto.Message)

func (*Experimental) XXX_Size

func (m *Experimental) XXX_Size() int

func (*Experimental) XXX_Unmarshal

func (m *Experimental) XXX_Unmarshal(b []byte) error

type LaunchStage

type LaunchStage int32

The launch stage as defined by [Google Cloud Platform Launch Stages](http://cloud.google.com/terms/launch-stages).

const (
	// Do not use this default value.
	LaunchStage_LAUNCH_STAGE_UNSPECIFIED LaunchStage = 0
	// Early Access features are limited to a closed group of testers. To use
	// these features, you must sign up in advance and sign a Trusted Tester
	// agreement (which includes confidentiality provisions). These features may
	// be unstable, changed in backward-incompatible ways, and are not
	// guaranteed to be released.
	LaunchStage_EARLY_ACCESS LaunchStage = 1
	// Alpha is a limited availability test for releases before they are cleared
	// for widespread use. By Alpha, all significant design issues are resolved
	// and we are in the process of verifying functionality. Alpha customers
	// need to apply for access, agree to applicable terms, and have their
	// projects whitelisted. Alpha releases don’t have to be feature complete,
	// no SLAs are provided, and there are no technical support obligations, but
	// they will be far enough along that customers can actually use them in
	// test environments or for limited-use tests -- just like they would in
	// normal production cases.
	LaunchStage_ALPHA LaunchStage = 2
	// Beta is the point at which we are ready to open a release for any
	// customer to use. There are no SLA or technical support obligations in a
	// Beta release. Products will be complete from a feature perspective, but
	// may have some open outstanding issues. Beta releases are suitable for
	// limited production use cases.
	LaunchStage_BETA LaunchStage = 3
	// GA features are open to all developers and are considered stable and
	// fully qualified for production use.
	LaunchStage_GA LaunchStage = 4
	// Deprecated features are scheduled to be shut down and removed. For more
	// information, see the “Deprecation Policy” section of our [Terms of
	// Service](https://cloud.google.com/terms/)
	// and the [Google Cloud Platform Subject to the Deprecation
	// Policy](https://cloud.google.com/terms/deprecation) documentation.
	LaunchStage_DEPRECATED LaunchStage = 5
)

func (LaunchStage) EnumDescriptor

func (LaunchStage) EnumDescriptor() ([]byte, []int)

func (LaunchStage) String

func (x LaunchStage) String() string