Package io.cucumber.messages

Interface Messages.AttachmentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Messages.Attachment, Messages.Attachment.Builder
    Enclosing class:
    Messages
    public static interface Messages.AttachmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasSource

        boolean hasSource()
        .io.cucumber.messages.SourceReference source = 1;

      • getTestStepId

        String getTestStepId()
        string test_step_id = 2;

      • getTestStepIdBytes

        com.google.protobuf.ByteString getTestStepIdBytes()
        string test_step_id = 2;

      • getTestCaseStartedId

        String getTestCaseStartedId()
        string test_case_started_id = 3;

      • getTestCaseStartedIdBytes

        com.google.protobuf.ByteString getTestCaseStartedIdBytes()
        string test_case_started_id = 3;

      • getBody

        String getBody()
        
 The body of the attachment. If `content_encoding` is `IDENTITY`, the attachment
 is simply the string. If it's `BASE64`, the string should be Base64 decoded to
 obtain the attachment.
        string body = 4;

      • getBodyBytes

        com.google.protobuf.ByteString getBodyBytes()
        
 The body of the attachment. If `content_encoding` is `IDENTITY`, the attachment
 is simply the string. If it's `BASE64`, the string should be Base64 decoded to
 obtain the attachment.
        string body = 4;

      • getMediaType

        String getMediaType()
        
 The media type of the data. This can be any valid
 [IANA Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml)
 as well as Cucumber-specific media types such as `text/x.cucumber.gherkin+plain`
 and `text/x.cucumber.stacktrace+plain`
        string media_type = 5;

      • getMediaTypeBytes

        com.google.protobuf.ByteString getMediaTypeBytes()
        
 The media type of the data. This can be any valid
 [IANA Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml)
 as well as Cucumber-specific media types such as `text/x.cucumber.gherkin+plain`
 and `text/x.cucumber.stacktrace+plain`
        string media_type = 5;

      • getContentEncodingValue

        int getContentEncodingValue()
        
 Whether to interpret `body` "as-is" (IDENTITY) or if it needs to be Base64-decoded (BASE64).
 Content encoding is *not* determined by the media type, but rather by the type
 of the object being attached:
 - string => IDENTITY
 - byte array => BASE64
 - stream => BASE64
        .io.cucumber.messages.Attachment.ContentEncoding content_encoding = 6;

      • getContentEncoding

        Messages.Attachment.ContentEncoding getContentEncoding()
        
 Whether to interpret `body` "as-is" (IDENTITY) or if it needs to be Base64-decoded (BASE64).
 Content encoding is *not* determined by the media type, but rather by the type
 of the object being attached:
 - string => IDENTITY
 - byte array => BASE64
 - stream => BASE64
        .io.cucumber.messages.Attachment.ContentEncoding content_encoding = 6;

      • getFileName

        String getFileName()
        
 Suggested file name of the attachment. (Provided by the user as an argument to `attach`)
        string file_name = 7;

      • getFileNameBytes

        com.google.protobuf.ByteString getFileNameBytes()
        
 Suggested file name of the attachment. (Provided by the user as an argument to `attach`)
        string file_name = 7;

      • getUrl

        String getUrl()
        
 A URL where the attachment can be retrieved. This field should not be set by Cucumber.
 It should be set by a program that reads a message stream and does the following for
 each Attachment message:
 - Writes the body (after base64 decoding if necessary) to a new file.
 - Sets `body` and `content_encoding` to `null`
 - Writes out the new attachment message
 This will result in a smaller message stream, which can improve performance and
 reduce bandwidth of message consumers. It also makes it easier to process and download attachments
 separately from reports.
        string url = 8;

      • getUrlBytes

        com.google.protobuf.ByteString getUrlBytes()
        
 A URL where the attachment can be retrieved. This field should not be set by Cucumber.
 It should be set by a program that reads a message stream and does the following for
 each Attachment message:
 - Writes the body (after base64 decoding if necessary) to a new file.
 - Sets `body` and `content_encoding` to `null`
 - Writes out the new attachment message
 This will result in a smaller message stream, which can improve performance and
 reduce bandwidth of message consumers. It also makes it easier to process and download attachments
 separately from reports.
        string url = 8;