names

Documentation

Index

• Constants
• func ApiRegexp() *regexp.Regexp
• func ApisRegexp() *regexp.Regexp
• func ArtifactRegexp() *regexp.Regexp
• func ArtifactsRegexp() *regexp.Regexp
• func GenerateID() string
• func ProjectRegexp() *regexp.Regexp
• func ProjectsRegexp() *regexp.Regexp
• func SpecRegexp() *regexp.Regexp
• func SpecsRegexp() *regexp.Regexp
• func VersionRegexp() *regexp.Regexp
• func VersionsRegexp() *regexp.Regexp
• type Api
  • func ParseApi(name string) (Api, error)
  • func (a Api) Artifact(id string) Artifact
  • func (a Api) Parent() string
  • func (a Api) Project() Project
  • func (a Api) String() string
  • func (a Api) Validate() error
  • func (a Api) Version(id string) Version
• type Artifact
  • func ParseArtifact(name string) (Artifact, error)
  • func (a Artifact) ApiID() string
  • func (a Artifact) ArtifactID() string
  • func (a Artifact) Parent() string
  • func (a Artifact) ProjectID() string
  • func (a Artifact) SpecID() string
  • func (a Artifact) String() string
  • func (a Artifact) Validate() error
  • func (a Artifact) VersionID() string
• type Project
  • func ParseProject(name string) (Project, error)
  • func ParseProjectWithLocation(name string) (Project, error)
  • func (p Project) Api(id string) Api
  • func (p Project) Artifact(id string) Artifact
  • func (p Project) String() string
  • func (p Project) Validate() error
• type Spec
  • func ParseSpec(name string) (Spec, error)
  • func (s Spec) Api() Api
  • func (s Spec) Artifact(id string) Artifact
  • func (s Spec) Normal() Spec
  • func (s Spec) Parent() string
  • func (s Spec) Project() Project
  • func (s Spec) Revision(id string) SpecRevision
  • func (s Spec) String() string
  • func (s Spec) Validate() error
  • func (s Spec) Version() Version
• type SpecRevision
  • func ParseSpecRevision(name string) (SpecRevision, error)
  • func (s SpecRevision) Spec() Spec
  • func (s SpecRevision) String() string
• type Version
  • func ParseVersion(name string) (Version, error)
  • func (v Version) Api() Api
  • func (v Version) Artifact(id string) Artifact
  • func (v Version) Parent() string
  • func (v Version) Project() Project
  • func (v Version) Spec(id string) Spec
  • func (v Version) String() string
  • func (v Version) Validate() error

Constants

const Location = "global"

Location is included in resource names immediately following the project_id.

Functions

func ApiRegexp

func ApiRegexp() *regexp.Regexp

ApiRegexp returns a regular expression that matches a api resource name.

func ApisRegexp

func ApisRegexp() *regexp.Regexp

ApisRegexp returns a regular expression that matches collection of apis.

func ArtifactRegexp

func ArtifactRegexp() *regexp.Regexp

ArtifactRegexp returns a regular expression that matches an artifact resource name.

func ArtifactsRegexp

func ArtifactsRegexp() *regexp.Regexp

ArtifactsRegexp returns a regular expression that matches collection of artifacts.

func GenerateID

func GenerateID() string

GenerateID generates a random resource ID.

func ProjectRegexp

func ProjectRegexp() *regexp.Regexp

ProjectRegexp returns a regular expression that matches a project resource name.

func ProjectsRegexp

func ProjectsRegexp() *regexp.Regexp

ProjectsRegexp returns a regular expression that matches collection of projects.

func SpecRegexp

func SpecRegexp() *regexp.Regexp

SpecRegexp returns a regular expression that matches a spec resource name with an optional revision identifier.

func SpecsRegexp

func SpecsRegexp() *regexp.Regexp

SpecsRegexp returns a regular expression that matches a collection of specs.

func VersionRegexp

func VersionRegexp() *regexp.Regexp

VersionRegexp returns a regular expression that matches a version resource name.

func VersionsRegexp

func VersionsRegexp() *regexp.Regexp

VersionsRegexp returns a regular expression that matches a collection of versions.

Types

type Api

type Api struct {
	ProjectID string
	ApiID     string
}

Api represents a resource name for an API.

func ParseApi

func ParseApi(name string) (Api, error)

ParseApi parses the name of an Api.

func (Api) Artifact

func (a Api) Artifact(id string) Artifact

Artifact returns an artifact with the provided ID and this resource as its parent.

func (Api) Parent

func (a Api) Parent() string

Parent returns this resource's parent project resource name.

func (Api) Project

func (a Api) Project() Project

Project returns the name of this resource's parent project.

func (Api) String

func (a Api) String() string

func (Api) Validate

func (a Api) Validate() error

Validate returns an error if the resource name is invalid. For backward compatibility, names should only be validated at creation time.

func (Api) Version

func (a Api) Version(id string) Version

Version returns an API version with the provided ID and this resource as its parent.

type Artifact

type Artifact struct {
	// contains filtered or unexported fields
}

Artifact represents a resource name for an artifact.

func ParseArtifact

func ParseArtifact(name string) (Artifact, error)

ParseArtifact parses the name of an artifact.

func (Artifact) ApiID

func (a Artifact) ApiID() string

ApiID returns the artifact's API ID, or empty string if it doesn't have one.

func (Artifact) ArtifactID

func (a Artifact) ArtifactID() string

ArtifactID returns the artifact's ID.

func (Artifact) Parent

func (a Artifact) Parent() string

Parent returns the resource name of the artifact's parent.

func (Artifact) ProjectID

func (a Artifact) ProjectID() string

ProjectID returns the artifact's project ID, or empty string if it doesn't have one.

func (Artifact) SpecID

func (a Artifact) SpecID() string

SpecID returns the artifact's spec ID, or empty string if it doesn't have one.

func (Artifact) String

func (a Artifact) String() string

func (Artifact) Validate

func (a Artifact) Validate() error

Validate returns an error if the resource name is invalid. For backward compatibility, names should only be validated at creation time.

func (Artifact) VersionID

func (a Artifact) VersionID() string

VersionID returns the artifact's version ID, or empty string if it doesn't have one.

type Project

type Project struct {
	ProjectID string
}

Project represents a resource name for a project.

func ParseProject

func ParseProject(name string) (Project, error)

ParseProject parses the name of a project.

func ParseProjectWithLocation

func ParseProjectWithLocation(name string) (Project, error)

ParseProjectWithLocation parses the name of a project.

func (Project) Api

func (p Project) Api(id string) Api

Api returns an API with the provided ID and this resource as its parent.

func (Project) Artifact

func (p Project) Artifact(id string) Artifact

Artifact returns an artifact with the provided ID and this resource as its parent.

func (Project) String

func (p Project) String() string

func (Project) Validate

func (p Project) Validate() error

Validate returns an error if the resource name is invalid. For backward compatibility, names should only be validated at creation time.

type Spec

type Spec struct {
	ProjectID string
	ApiID     string
	VersionID string
	SpecID    string
}

Spec represents a resource name for an API spec.

func ParseSpec

func ParseSpec(name string) (Spec, error)

ParseSpec parses the name of a spec.

func (Spec) Api

func (s Spec) Api() Api

Api returns the parent API for this resource.

func (Spec) Artifact

func (s Spec) Artifact(id string) Artifact

Artifact returns an artifact with the provided ID and this resource as its parent.

func (Spec) Normal

func (s Spec) Normal() Spec

Normal returns the resource name with normalized identifiers.

func (Spec) Parent

func (s Spec) Parent() string

Parent returns this resource's parent version resource name.

func (Spec) Project

func (s Spec) Project() Project

Project returns the parent project for this resource.

func (Spec) Revision

func (s Spec) Revision(id string) SpecRevision

Revision returns an API spec revision with the provided ID and this resource as its parent.

func (Spec) String

func (s Spec) String() string

func (Spec) Validate

func (s Spec) Validate() error

Validate returns an error if the resource name is invalid. For backward compatibility, names should only be validated at creation time.

func (Spec) Version

func (s Spec) Version() Version

Version returns the parent API version for this resource.

type SpecRevision

type SpecRevision struct {
	ProjectID  string
	ApiID      string
	VersionID  string
	SpecID     string
	RevisionID string
}

SpecRevision represents a resource name for an API spec revision.

func ParseSpecRevision

func ParseSpecRevision(name string) (SpecRevision, error)

ParseSpecRevision parses the name of a spec.

func (SpecRevision) Spec

func (s SpecRevision) Spec() Spec

Spec returns the parent spec for this resource.

func (SpecRevision) String

func (s SpecRevision) String() string

type Version

type Version struct {
	ProjectID string
	ApiID     string
	VersionID string
}

Version represents a resource name for an API version.

func ParseVersion

func ParseVersion(name string) (Version, error)

ParseVersion parses the name of a version.

func (Version) Api

func (v Version) Api() Api

Api returns the parent API for this resource.

func (Version) Artifact

func (v Version) Artifact(id string) Artifact

Artifact returns an artifact with the provided ID and this resource as its parent.

func (Version) Parent

func (v Version) Parent() string

Parent returns this resource's parent API resource name.

func (Version) Project

func (v Version) Project() Project

Project returns the parent project for this resource.

func (Version) Spec

func (v Version) Spec(id string) Spec

Spec returns an API spec with the provided ID and this resource as its parent.

func (Version) String

func (v Version) String() string

func (Version) Validate

func (v Version) Validate() error

Validate returns an error if the resource name is invalid. For backward compatibility, names should only be validated at creation time.