Reference documentation and code samples for the proto library Client class Annotation.
Generated from protobuf message google.protobuf.GeneratedCodeInfo.Annotation
Namespace
Google \ Protobuf \ Internal \ GeneratedCodeInfoMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ path |
int[]
Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path. |
↳ source_file |
string
Identifies the filesystem path to the original source .proto. |
↳ begin |
int
Identifies the starting offset in bytes in the generated code that relates to the identified object. |
↳ end |
int
Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin). |
↳ semantic |
int
|
getPath
Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
setPath
Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceFile
Identifies the filesystem path to the original source .proto.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSourceFile
clearSourceFile
setSourceFile
Identifies the filesystem path to the original source .proto.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBegin
Identifies the starting offset in bytes in the generated code that relates to the identified object.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasBegin
clearBegin
setBegin
Identifies the starting offset in bytes in the generated code that relates to the identified object.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnd
Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).
| Returns | |
|---|---|
| Type | Description |
int |
|
hasEnd
clearEnd
setEnd
Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSemantic
Generated from protobuf field optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;
| Returns | |
|---|---|
| Type | Description |
int |
one of the values in {@see \Google\Protobuf\Internal\GeneratedCodeInfo\Annotation\Semantic} |
hasSemantic
clearSemantic
setSemantic
Generated from protobuf field optional .google.protobuf.GeneratedCodeInfo.Annotation.Semantic semantic = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
int
one of the values in Annotation\Semantic |
| Returns | |
|---|---|
| Type | Description |
$this |
|