Reference documentation and code samples for the Cloud PubSub V1 Client class ListSnapshotsRequest.
Request for the ListSnapshots method.
Generated from protobuf message google.pubsub.v1.ListSnapshotsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project |
string
Required. The name of the project in which to list snapshots. Format is |
↳ page_size |
int
Maximum number of snapshots to return. |
↳ page_token |
string
The value returned by the last |
getProject
Required. The name of the project in which to list snapshots.
Format is projects/{project-id}.
Generated from protobuf field string project = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setProject
Required. The name of the project in which to list snapshots.
Format is projects/{project-id}.
Generated from protobuf field string project = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Maximum number of snapshots to return.
Generated from protobuf field int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Maximum number of snapshots to return.
Generated from protobuf field int32 page_size = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
The value returned by the last ListSnapshotsResponse; indicates that this
is a continuation of a prior ListSnapshots call, and that the system
should return the next page of data.
Generated from protobuf field string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
The value returned by the last ListSnapshotsResponse; indicates that this
is a continuation of a prior ListSnapshots call, and that the system
should return the next page of data.
Generated from protobuf field string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |