Class ListPagesRequest (0.45.0)

public final class ListPagesRequest extends GeneratedMessageV3 implements ListPagesRequestOrBuilder

The request message for Pages.ListPages.

Protobuf type google.cloud.dialogflow.cx.v3.ListPagesRequest

Static Fields

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListPagesRequest getDefaultInstance()
Returns
Type Description
ListPagesRequest

getDescriptor()

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

newBuilder()

public static ListPagesRequest.Builder newBuilder()
Returns
Type Description
ListPagesRequest.Builder

newBuilder(ListPagesRequest prototype)

public static ListPagesRequest.Builder newBuilder(ListPagesRequest prototype)
Parameter
Name Description
prototype ListPagesRequest
Returns
Type Description
ListPagesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListPagesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPagesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListPagesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListPagesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListPagesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListPagesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListPagesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPagesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListPagesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPagesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListPagesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListPagesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPagesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListPagesRequest> parser()
Returns
Type Description
Parser<ListPagesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListPagesRequest getDefaultInstanceForType()
Returns
Type Description
ListPagesRequest

getLanguageCode()

public String getLanguageCode()

The language to list pages for. The following fields are language dependent:

  • Page.entry_fulfillment.messages
  • Page.entry_fulfillment.conditional_cases
  • Page.event_handlers.trigger_fulfillment.messages
  • Page.event_handlers.trigger_fulfillment.conditional_cases
  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages * Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
  • Page.transition_routes.trigger_fulfillment.messages
  • Page.transition_routes.trigger_fulfillment.conditional_cases

    If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

string language_code = 2;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

The language to list pages for. The following fields are language dependent:

  • Page.entry_fulfillment.messages
  • Page.entry_fulfillment.conditional_cases
  • Page.event_handlers.trigger_fulfillment.messages
  • Page.event_handlers.trigger_fulfillment.conditional_cases
  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases
  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages * Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases
  • Page.transition_routes.trigger_fulfillment.messages
  • Page.transition_routes.trigger_fulfillment.conditional_cases

    If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

string language_code = 2;

Returns
Type Description
ByteString

The bytes for languageCode.

getPageSize()

public int getPageSize()

The maximum number of items to return in a single page. By default 100 and at most 1000.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

The next_page_token value returned from a previous list request.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The next_page_token value returned from a previous list request.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The flow to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow 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 flow to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListPagesRequest> getParserForType()
Returns
Type Description
Parser<ListPagesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListPagesRequest.Builder newBuilderForType()
Returns
Type Description
ListPagesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListPagesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListPagesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListPagesRequest.Builder toBuilder()
Returns
Type Description
ListPagesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException