Reference documentation and code samples for the Grafeas V1 Client class Version.
Version contains structured information about the version of a package.
Generated from protobuf message grafeas.v1.Version
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ epoch |
int
Used to correct mistakes in the version numbering scheme. |
↳ name |
string
Required only when version kind is NORMAL. The main part of the version name. |
↳ revision |
string
The iteration of the package build from the above version. |
↳ inclusive |
bool
Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range. |
↳ kind |
int
Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
↳ full_name |
string
Human readable version string. This string is of the form
|
getEpoch
Used to correct mistakes in the version numbering scheme.
| Returns | |
|---|---|
| Type | Description |
int | |
setEpoch
Used to correct mistakes in the version numbering scheme.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
Required only when version kind is NORMAL. The main part of the version name.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required only when version kind is NORMAL. The main part of the version name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRevision
The iteration of the package build from the above version.
| Returns | |
|---|---|
| Type | Description |
string | |
setRevision
The iteration of the package build from the above version.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInclusive
Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
| Returns | |
|---|---|
| Type | Description |
bool | |
setInclusive
Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
| Returns | |
|---|---|
| Type | Description |
int | |
setKind
Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFullName
Human readable version string. This string is of the form
| Returns | |
|---|---|
| Type | Description |
string | |
setFullName
Human readable version string. This string is of the form
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |