Class ExportFlowRequest

  • All Implemented Interfaces:
    ExportFlowRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ExportFlowRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements ExportFlowRequestOrBuilder
     The request message for
     [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].
     
    Protobuf type google.cloud.dialogflow.cx.v3.ExportFlowRequest
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExportFlowRequest.Builder
      The request message for [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FLOW_URI_FIELD_NUMBER  
      static int INCLUDE_REFERENCED_FLOWS_FIELD_NUMBER  
      static int NAME_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Field Detail

      • INCLUDE_REFERENCED_FLOWS_FIELD_NUMBER

        public static final int INCLUDE_REFERENCED_FLOWS_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getName

        public String getName()
         Required. The name of the flow to export.
         Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
         ID>/flows/<Flow ID>`.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface ExportFlowRequestOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The name of the flow to export.
         Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
         ID>/flows/<Flow ID>`.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface ExportFlowRequestOrBuilder
        Returns:
        The bytes for name.
      • getFlowUri

        public String getFlowUri()
         Optional. The [Google Cloud
         Storage](https://cloud.google.com/storage/docs/) URI to export the flow to.
         The format of this URI must be `gs://<bucket-name>/<object-name>`. If left
         unspecified, the serialized flow is returned inline.
        
         Dialogflow performs a write operation for the Cloud Storage object
         on the caller's behalf, so your request authentication must
         have write permissions for the object. For more information, see
         [Dialogflow access
         control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
         
        string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFlowUri in interface ExportFlowRequestOrBuilder
        Returns:
        The flowUri.
      • getFlowUriBytes

        public com.google.protobuf.ByteString getFlowUriBytes()
         Optional. The [Google Cloud
         Storage](https://cloud.google.com/storage/docs/) URI to export the flow to.
         The format of this URI must be `gs://<bucket-name>/<object-name>`. If left
         unspecified, the serialized flow is returned inline.
        
         Dialogflow performs a write operation for the Cloud Storage object
         on the caller's behalf, so your request authentication must
         have write permissions for the object. For more information, see
         [Dialogflow access
         control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
         
        string flow_uri = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFlowUriBytes in interface ExportFlowRequestOrBuilder
        Returns:
        The bytes for flowUri.
      • getIncludeReferencedFlows

        public boolean getIncludeReferencedFlows()
         Optional. Whether to export flows referenced by the specified flow.
         
        bool include_referenced_flows = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getIncludeReferencedFlows in interface ExportFlowRequestOrBuilder
        Returns:
        The includeReferencedFlows.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static ExportFlowRequest parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ExportFlowRequest parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ExportFlowRequest parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ExportFlowRequest parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ExportFlowRequest parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ExportFlowRequest parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ExportFlowRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException
        Throws:
        IOException
      • newBuilderForType

        public ExportFlowRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public ExportFlowRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected ExportFlowRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<ExportFlowRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

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