class DeploymentEvent

github :: DeploymentEvent

Triggered when a new snapshot is deployed.

Deployement are mainly used with integration testing servers.

Introduced properties

init defaultinit(id: nullable String, action: nullable String, repo: Repo, sha: String, name: String, payload: nullable String, environment: nullable String, description: nullable String)

github :: DeploymentEvent :: defaultinit

fun description: nullable String

github :: DeploymentEvent :: description

Optional human-readable description added to the deployment.
fun description=(description: nullable String)

github :: DeploymentEvent :: description=

Optional human-readable description added to the deployment.
fun environment: nullable String

github :: DeploymentEvent :: environment

Optional environment to deploy to.
fun environment=(environment: nullable String)

github :: DeploymentEvent :: environment=

Optional environment to deploy to.
fun name: String

github :: DeploymentEvent :: name

Name of repository for this deployment, formatted as :owner/:repo.
fun name=(name: String)

github :: DeploymentEvent :: name=

Name of repository for this deployment, formatted as :owner/:repo.
fun payload: nullable String

github :: DeploymentEvent :: payload

Optional extra information for this deployment.
fun payload=(payload: nullable String)

github :: DeploymentEvent :: payload=

Optional extra information for this deployment.
fun sha: String

github :: DeploymentEvent :: sha

Commit SHA for which this deployment was created.
fun sha=(sha: String)

github :: DeploymentEvent :: sha=

Commit SHA for which this deployment was created.

Redefined properties

redef type SELF: DeploymentEvent

github $ DeploymentEvent :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

github $ DeploymentEvent :: core_serialize_to

Actual serialization of self to serializer
redef init from_deserializer(v: Deserializer)

github $ DeploymentEvent :: from_deserializer

Create an instance of this class from the deserializer

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
fun action: nullable String

github :: GithubEvent :: action

Action performed by the event.
fun action=(action: nullable String)

github :: GithubEvent :: action=

Action performed by the event.
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
init defaultinit(id: nullable String, action: nullable String, repo: Repo, sha: String, name: String, payload: nullable String, environment: nullable String, description: nullable String)

github :: DeploymentEvent :: defaultinit

init defaultinit(id: nullable String, action: nullable String, repo: Repo)

github :: GithubEvent :: defaultinit

fun description: nullable String

github :: DeploymentEvent :: description

Optional human-readable description added to the deployment.
fun description=(description: nullable String)

github :: DeploymentEvent :: description=

Optional human-readable description added to the deployment.
fun environment: nullable String

github :: DeploymentEvent :: environment

Optional environment to deploy to.
fun environment=(environment: nullable String)

github :: DeploymentEvent :: environment=

Optional environment to deploy to.
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun id: nullable String

github :: GithubEvent :: id

Event ID from Github.
fun id=(id: nullable String)

github :: GithubEvent :: id=

Event ID from Github.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
fun name: String

github :: DeploymentEvent :: name

Name of repository for this deployment, formatted as :owner/:repo.
fun name=(name: String)

github :: DeploymentEvent :: name=

Name of repository for this deployment, formatted as :owner/:repo.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun payload: nullable String

github :: DeploymentEvent :: payload

Optional extra information for this deployment.
fun payload=(payload: nullable String)

github :: DeploymentEvent :: payload=

Optional extra information for this deployment.
fun repo: Repo

github :: GithubEvent :: repo

Repo where this event occured.
fun repo=(repo: Repo)

github :: GithubEvent :: repo=

Repo where this event occured.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
fun sha: String

github :: DeploymentEvent :: sha

Commit SHA for which this deployment was created.
fun sha=(sha: String)

github :: DeploymentEvent :: sha=

Commit SHA for which this deployment was created.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram github::DeploymentEvent DeploymentEvent github::GithubEvent GithubEvent github::DeploymentEvent->github::GithubEvent serialization::Serializable Serializable github::GithubEvent->serialization::Serializable ...serialization::Serializable ... ...serialization::Serializable->serialization::Serializable

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Parents

class GithubEvent

github :: GithubEvent

Github event stub.

Class definitions

github $ DeploymentEvent 
# Triggered when a new snapshot is deployed.
#
# Deployement are mainly used with integration testing servers.
class DeploymentEvent
	super GithubEvent
	serialize

	# Commit SHA for which this deployment was created.
	var sha: String is writable

	# Name of repository for this deployment, formatted as :owner/:repo.
	var name: String is writable

	# Optional extra information for this deployment.
	var payload: nullable String is writable

	# Optional environment to deploy to.
	# Default: "production"
	var environment: nullable String is writable

	# Optional human-readable description added to the deployment.
	var description: nullable String is writable
end
lib/github/events.nit:80,1--102,3
Nit standard library. Version .