Stackdriver Logging V2 Client - Class ListLogsRequest (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

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The resource name that owns the logs: * projects/[PROJECT_ID] * organizations/[ORGANIZATION_ID] * billingAccounts/[BILLING_ACCOUNT_ID] * folders/[FOLDER_ID]

↳ 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.

↳ resource_names
array

Optional. The resource name that owns the logs: * 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]

getParent

Required. The resource name that owns the logs:

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type
Description
string

setParent

Required. The resource name that owns the logs:

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

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.

Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

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.

Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

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.

Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

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.

Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getResourceNames

Optional. The resource name that owns the logs:

  • 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]

Generated from protobuf field repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = {

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setResourceNames

Optional. The resource name that owns the logs:

  • 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]

Generated from protobuf field repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: