BigQuery Data Transfer V1 Client - Class ListTransferLogsRequest (2.1.1)

Reference documentation and code samples for the BigQuery Data Transfer V1 Client class ListTransferLogsRequest.

A request to get user facing log messages associated with data transfer run.

Generated from protobuf message google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest

Namespace

Google \ Cloud \ BigQuery \ DataTransfer \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
↳ page_token string

Pagination token, which can be used to request a specific page of ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.
↳ page_size int

Page size. The default page size is the maximum value of 1000 results.
↳ message_types array

Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

getParent

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Returns
Type Description
string

setParent

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageToken

Pagination token, which can be used to request a specific page of ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Returns
Type Description
string

setPageToken

Pagination token, which can be used to request a specific page of ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Page size. The default page size is the maximum value of 1000 results.

Returns
Type Description
int

setPageSize

Page size. The default page size is the maximum value of 1000 results.

Parameter
Name Description
var int
Returns
Type Description
$this

getMessageTypes

Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMessageTypes

Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

Parameter
Name Description
var int[]
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id} Please see DataTransferServiceClient::runName() for help formatting this field.
Returns
Type Description
ListTransferLogsRequest