Package com.google.cloud.workflows.executions.v1beta

Class ListExecutionsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListExecutionsRequest.Builder>
com.google.cloud.workflows.executions.v1beta.ListExecutionsRequest.Builder
All Implemented Interfaces:
ListExecutionsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListExecutionsRequest
public static final class ListExecutionsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListExecutionsRequest.Builder> implements ListExecutionsRequestOrBuilder
 Request for the
 [ListExecutions][google.cloud.workflows.executions.v1beta.Executions.ListExecutions]
 method.
Protobuf type google.cloud.workflows.executions.v1beta.ListExecutionsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListExecutionsRequest.Builder>

    • clear

      public ListExecutionsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListExecutionsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListExecutionsRequest.Builder>

    • getDefaultInstanceForType

      public ListExecutionsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListExecutionsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListExecutionsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListExecutionsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListExecutionsRequest.Builder>

    • mergeFrom

      public ListExecutionsRequest.Builder mergeFrom(ListExecutionsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListExecutionsRequest.Builder>

    • mergeFrom

      public ListExecutionsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListExecutionsRequest.Builder>
      Throws:
      IOException

    • getParent

      public String getParent()
       Required. Name of the workflow for which the executions should be listed.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListExecutionsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. Name of the workflow for which the executions should be listed.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListExecutionsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ListExecutionsRequest.Builder setParent(String value)
       Required. Name of the workflow for which the executions should be listed.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListExecutionsRequest.Builder clearParent()
       Required. Name of the workflow for which the executions should be listed.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public ListExecutionsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. Name of the workflow for which the executions should be listed.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public int getPageSize()
       Maximum number of executions to return per call.
 Max supported value depends on the selected Execution view: it's 10000 for
 BASIC and 100 for FULL. The default value used if the field is not
 specified is 100, regardless of the selected view. Values greater than
 the max value will be coerced down to it.
      int32 page_size = 2;
      Specified by:
      getPageSize in interface ListExecutionsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListExecutionsRequest.Builder setPageSize(int value)
       Maximum number of executions to return per call.
 Max supported value depends on the selected Execution view: it's 10000 for
 BASIC and 100 for FULL. The default value used if the field is not
 specified is 100, regardless of the selected view. Values greater than
 the max value will be coerced down to it.
      int32 page_size = 2;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListExecutionsRequest.Builder clearPageSize()
       Maximum number of executions to return per call.
 Max supported value depends on the selected Execution view: it's 10000 for
 BASIC and 100 for FULL. The default value used if the field is not
 specified is 100, regardless of the selected view. Values greater than
 the max value will be coerced down to it.
      int32 page_size = 2;
      Returns:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       A page token, received from a previous `ListExecutions` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListExecutions` must
 match the call that provided the page token.
      string page_token = 3;
      Specified by:
      getPageToken in interface ListExecutionsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous `ListExecutions` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListExecutions` must
 match the call that provided the page token.
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface ListExecutionsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListExecutionsRequest.Builder setPageToken(String value)
       A page token, received from a previous `ListExecutions` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListExecutions` must
 match the call that provided the page token.
      string page_token = 3;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListExecutionsRequest.Builder clearPageToken()
       A page token, received from a previous `ListExecutions` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListExecutions` must
 match the call that provided the page token.
      string page_token = 3;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListExecutionsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A page token, received from a previous `ListExecutions` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListExecutions` must
 match the call that provided the page token.
      string page_token = 3;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getViewValue

      public int getViewValue()
       Optional. A view defining which fields should be filled in the returned executions.
 The API will default to the BASIC view.
      .google.cloud.workflows.executions.v1beta.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getViewValue in interface ListExecutionsRequestOrBuilder
      Returns:
      The enum numeric value on the wire for view.

    • setViewValue

      public ListExecutionsRequest.Builder setViewValue(int value)
       Optional. A view defining which fields should be filled in the returned executions.
 The API will default to the BASIC view.
      .google.cloud.workflows.executions.v1beta.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for view to set.
      Returns:
      This builder for chaining.

    • getView

      public ExecutionView getView()
       Optional. A view defining which fields should be filled in the returned executions.
 The API will default to the BASIC view.
      .google.cloud.workflows.executions.v1beta.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getView in interface ListExecutionsRequestOrBuilder
      Returns:
      The view.

    • setView

      public ListExecutionsRequest.Builder setView(ExecutionView value)
       Optional. A view defining which fields should be filled in the returned executions.
 The API will default to the BASIC view.
      .google.cloud.workflows.executions.v1beta.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The view to set.
      Returns:
      This builder for chaining.

    • clearView

      public ListExecutionsRequest.Builder clearView()
       Optional. A view defining which fields should be filled in the returned executions.
 The API will default to the BASIC view.
      .google.cloud.workflows.executions.v1beta.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.