Class ListLogsRequest.Builder (3.17.2)

public static final class ListLogsRequest.Builder extends GeneratedMessageV3.Builder<ListLogsRequest.Builder> implements ListLogsRequestOrBuilder

The parameters to ListLogs.

Protobuf type google.logging.v2.ListLogsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListLogsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllResourceNames(Iterable<String> values)

public ListLogsRequest.Builder addAllResourceNames(Iterable<String> values)

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The resourceNames to add.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListLogsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListLogsRequest.Builder
Overrides

addResourceNames(String value)

public ListLogsRequest.Builder addResourceNames(String value)

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The resourceNames to add.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

addResourceNamesBytes(ByteString value)

public ListLogsRequest.Builder addResourceNamesBytes(ByteString value)

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the resourceNames to add.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

build()

public ListLogsRequest build()
Returns
Type Description
ListLogsRequest

buildPartial()

public ListLogsRequest buildPartial()
Returns
Type Description
ListLogsRequest

clear()

public ListLogsRequest.Builder clear()
Returns
Type Description
ListLogsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListLogsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListLogsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListLogsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListLogsRequest.Builder
Overrides

clearPageSize()

public ListLogsRequest.Builder clearPageSize()

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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

clearPageToken()

public ListLogsRequest.Builder clearPageToken()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

clearParent()

public ListLogsRequest.Builder clearParent()

Required. The resource name to list logs for:

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

clearResourceNames()

public ListLogsRequest.Builder clearResourceNames()

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

clone()

public ListLogsRequest.Builder clone()
Returns
Type Description
ListLogsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListLogsRequest getDefaultInstanceForType()
Returns
Type Description
ListLogsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int 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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String 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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name to list logs for:

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name to list logs for:

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getResourceNames(int index)

public String getResourceNames(int index)

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The resourceNames at the given index.

getResourceNamesBytes(int index)

public ByteString getResourceNamesBytes(int index)

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the resourceNames at the given index.

getResourceNamesCount()

public int getResourceNamesCount()

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of resourceNames.

getResourceNamesList()

public ProtocolStringList getResourceNamesList()

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the resourceNames.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListLogsRequest other)

public ListLogsRequest.Builder mergeFrom(ListLogsRequest other)
Parameter
Name Description
other ListLogsRequest
Returns
Type Description
ListLogsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListLogsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListLogsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListLogsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListLogsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListLogsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListLogsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListLogsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListLogsRequest.Builder
Overrides

setPageSize(int value)

public ListLogsRequest.Builder setPageSize(int value)

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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListLogsRequest.Builder setPageToken(String value)

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListLogsRequest.Builder setPageTokenBytes(ByteString value)

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

setParent(String value)

public ListLogsRequest.Builder setParent(String value)

Required. The resource name to list logs for:

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListLogsRequest.Builder setParentBytes(ByteString value)

Required. The resource name to list logs for:

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListLogsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListLogsRequest.Builder
Overrides

setResourceNames(int index, String value)

public ListLogsRequest.Builder setResourceNames(int index, String value)

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.

repeated string resource_names = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.
value String

The resourceNames to set.
Returns
Type Description
ListLogsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListLogsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListLogsRequest.Builder
Overrides