BigQuery Data Transfer V1 Client - Class ListTransferLogsRequest (1.3.8)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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}

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

Returns
TypeDescription
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}

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field string page_token = 4;

Returns
TypeDescription
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.

Generated from protobuf field string page_token = 4;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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

Generated from protobuf field int32 page_size = 5;

Returns
TypeDescription
int

setPageSize

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

Generated from protobuf field int32 page_size = 5;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMessageTypes

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

Generated from protobuf field repeated .google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity message_types = 6;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMessageTypes

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

Generated from protobuf field repeated .google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity message_types = 6;

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this