• Home
• com.google.api.grpc
• proto-google-cloud-storage-v2
• 2.39.0-alpha
• source code
• ListObjectsRequestOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.storage.v2.ListObjectsRequestOrBuilder Maven / Gradle / Ivy

/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/storage/v2/storage.proto

// Protobuf Java Version: 3.25.3
package com.google.storage.v2;

public interface ListObjectsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.storage.v2.ListObjectsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * Required. Name of the bucket in which to look for objects.
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   * 
   * Required. Name of the bucket in which to look for objects.
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   * 
   * Maximum number of `items` plus `prefixes` to return
   * in a single page of responses. As duplicate `prefixes` are
   * omitted, fewer total results may be returned than requested. The service
   * will use this parameter or 1,000 items, whichever is smaller.
   * 
   *
   * int32 page_size = 2;
   *
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *
   *
   * 
   * A previously-returned page token representing part of the larger set of
   * results to view.
   * 
   *
   * string page_token = 3;
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   * 
   * A previously-returned page token representing part of the larger set of
   * results to view.
   * 
   *
   * string page_token = 3;
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   * 
   * If set, returns results in a directory-like mode. `items` will contain
   * only objects whose names, aside from the `prefix`, do not
   * contain `delimiter`. Objects whose names, aside from the
   * `prefix`, contain `delimiter` will have their name,
   * truncated after the `delimiter`, returned in
   * `prefixes`. Duplicate `prefixes` are omitted.
   * 
   *
   * string delimiter = 4;
   *
   * @return The delimiter.
   */
  java.lang.String getDelimiter();
  /**
   *
   *
   * 
   * If set, returns results in a directory-like mode. `items` will contain
   * only objects whose names, aside from the `prefix`, do not
   * contain `delimiter`. Objects whose names, aside from the
   * `prefix`, contain `delimiter` will have their name,
   * truncated after the `delimiter`, returned in
   * `prefixes`. Duplicate `prefixes` are omitted.
   * 
   *
   * string delimiter = 4;
   *
   * @return The bytes for delimiter.
   */
  com.google.protobuf.ByteString getDelimiterBytes();

  /**
   *
   *
   * 
   * If true, objects that end in exactly one instance of `delimiter`
   * will have their metadata included in `items` in addition to
   * `prefixes`.
   * 
   *
   * bool include_trailing_delimiter = 5;
   *
   * @return The includeTrailingDelimiter.
   */
  boolean getIncludeTrailingDelimiter();

  /**
   *
   *
   * 
   * Filter results to objects whose names begin with this prefix.
   * 
   *
   * string prefix = 6;
   *
   * @return The prefix.
   */
  java.lang.String getPrefix();
  /**
   *
   *
   * 
   * Filter results to objects whose names begin with this prefix.
   * 
   *
   * string prefix = 6;
   *
   * @return The bytes for prefix.
   */
  com.google.protobuf.ByteString getPrefixBytes();

  /**
   *
   *
   * 
   * If `true`, lists all versions of an object as distinct results.
   * For more information, see
   * [Object
   * Versioning](https://cloud.google.com/storage/docs/object-versioning).
   * 
   *
   * bool versions = 7;
   *
   * @return The versions.
   */
  boolean getVersions();

  /**
   *
   *
   * 
   * Mask specifying which fields to read from each result.
   * If no mask is specified, will default to all fields except items.acl and
   * items.owner.
   * * may be used to mean "all fields".
   * 
   *
   * optional .google.protobuf.FieldMask read_mask = 8;
   *
   * @return Whether the readMask field is set.
   */
  boolean hasReadMask();
  /**
   *
   *
   * 
   * Mask specifying which fields to read from each result.
   * If no mask is specified, will default to all fields except items.acl and
   * items.owner.
   * * may be used to mean "all fields".
   * 
   *
   * optional .google.protobuf.FieldMask read_mask = 8;
   *
   * @return The readMask.
   */
  com.google.protobuf.FieldMask getReadMask();
  /**
   *
   *
   * 
   * Mask specifying which fields to read from each result.
   * If no mask is specified, will default to all fields except items.acl and
   * items.owner.
   * * may be used to mean "all fields".
   * 
   *
   * optional .google.protobuf.FieldMask read_mask = 8;
   */
  com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder();

  /**
   *
   *
   * 
   * Optional. Filter results to objects whose names are lexicographically equal
   * to or after lexicographic_start. If lexicographic_end is also set, the
   * objects listed have names between lexicographic_start (inclusive) and
   * lexicographic_end (exclusive).
   * 
   *
   * string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The lexicographicStart.
   */
  java.lang.String getLexicographicStart();
  /**
   *
   *
   * 
   * Optional. Filter results to objects whose names are lexicographically equal
   * to or after lexicographic_start. If lexicographic_end is also set, the
   * objects listed have names between lexicographic_start (inclusive) and
   * lexicographic_end (exclusive).
   * 
   *
   * string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for lexicographicStart.
   */
  com.google.protobuf.ByteString getLexicographicStartBytes();

  /**
   *
   *
   * 
   * Optional. Filter results to objects whose names are lexicographically
   * before lexicographic_end. If lexicographic_start is also set, the objects
   * listed have names between lexicographic_start (inclusive) and
   * lexicographic_end (exclusive).
   * 
   *
   * string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The lexicographicEnd.
   */
  java.lang.String getLexicographicEnd();
  /**
   *
   *
   * 
   * Optional. Filter results to objects whose names are lexicographically
   * before lexicographic_end. If lexicographic_start is also set, the objects
   * listed have names between lexicographic_start (inclusive) and
   * lexicographic_end (exclusive).
   * 
   *
   * string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for lexicographicEnd.
   */
  com.google.protobuf.ByteString getLexicographicEndBytes();

  /**
   *
   *
   * 
   * Optional. If true, only list all soft-deleted versions of the object.
   * Soft delete policy is required to set this option.
   * 
   *
   * bool soft_deleted = 12 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The softDeleted.
   */
  boolean getSoftDeleted();

  /**
   *
   *
   * 
   * Optional. If true, will also include folders and managed folders (besides
   * objects) in the returned `prefixes`. Requires `delimiter` to be set to '/'.
   * 
   *
   * bool include_folders_as_prefixes = 13 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The includeFoldersAsPrefixes.
   */
  boolean getIncludeFoldersAsPrefixes();

  /**
   *
   *
   * 
   * Optional. Filter results to objects and prefixes that match this glob
   * pattern. See [List Objects Using
   * Glob](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob)
   * for the full syntax.
   * 
   *
   * string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The matchGlob.
   */
  java.lang.String getMatchGlob();
  /**
   *
   *
   * 
   * Optional. Filter results to objects and prefixes that match this glob
   * pattern. See [List Objects Using
   * Glob](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob)
   * for the full syntax.
   * 
   *
   * string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for matchGlob.
   */
  com.google.protobuf.ByteString getMatchGlobBytes();
}