Stackdriver Logging V2 Client - Class ListLogsRequest (1.29.0)

Version 1.29.0

• 1.31.1 (latest)
• 1.31.0
• 1.30.3
• 1.29.0
• 1.28.5
• 1.27.1
• 1.26.0
• 1.25.5
• 1.24.10

Reference documentation and code samples for the Stackdriver Logging V2 Client class ListLogsRequest.

The parameters to ListLogs.

Generated from protobuf message google.logging.v2.ListLogsRequest

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The resource name to list logs for: * projects/[PROJECT_ID] * organizations/[ORGANIZATION_ID] * billingAccounts/[BILLING_ACCOUNT_ID] * folders/[FOLDER_ID]
↳ resource_names	array Optional. List of resource names to list logs for: * projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] * folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] To support legacy queries, it could also be: * projects/[PROJECT_ID] * organizations/[ORGANIZATION_ID] * billingAccounts/[BILLING_ACCOUNT_ID] * folders/[FOLDER_ID] The resource name in the parent field is added to this list.
↳ page_size	int Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
↳ page_token	string Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

getParent

Required. The resource name to list logs for:

• projects/[PROJECT_ID]
• organizations/[ORGANIZATION_ID]
• billingAccounts/[BILLING_ACCOUNT_ID]
• folders/[FOLDER_ID]

Returns
Type	Description
string

setParent

Required. The resource name to list logs for:

• projects/[PROJECT_ID]
• organizations/[ORGANIZATION_ID]
• billingAccounts/[BILLING_ACCOUNT_ID]
• folders/[FOLDER_ID]

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getResourceNames

Optional. List of resource names to list logs for:

• projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
• organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
• billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
• folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] To support legacy queries, it could also be:
  • projects/[PROJECT_ID]
  • organizations/[ORGANIZATION_ID]
  • billingAccounts/[BILLING_ACCOUNT_ID]
  • folders/[FOLDER_ID] The resource name in the parent field is added to this list.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setResourceNames

Optional. List of resource names to list logs for:

• projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
• organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
• billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
• folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] To support legacy queries, it could also be:
  • projects/[PROJECT_ID]
  • organizations/[ORGANIZATION_ID]
  • billingAccounts/[BILLING_ACCOUNT_ID]
  • folders/[FOLDER_ID] The resource name in the parent field is added to this list.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

Returns
Type	Description
string

setPageToken

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] Please see Google\Cloud\Logging\V2\LoggingServiceV2Client::projectName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Logging\V2\ListLogsRequest