Class ReportConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.storageinsights.v1.ReportConfig
All Implemented Interfaces:
ReportConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ReportConfig extends com.google.protobuf.GeneratedMessage implements ReportConfigOrBuilder
 Message describing ReportConfig object. ReportConfig is the configuration to
 generate reports.
 See
 https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
 for more details on how to set various fields.
 Next ID: 12
 
Protobuf type google.cloud.storageinsights.v1.ReportConfig
See Also:
  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:
    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:
    • FREQUENCY_OPTIONS_FIELD_NUMBER

      public static final int FREQUENCY_OPTIONS_FIELD_NUMBER
      See Also:
    • CSV_OPTIONS_FIELD_NUMBER

      public static final int CSV_OPTIONS_FIELD_NUMBER
      See Also:
    • PARQUET_OPTIONS_FIELD_NUMBER

      public static final int PARQUET_OPTIONS_FIELD_NUMBER
      See Also:
    • OBJECT_METADATA_REPORT_OPTIONS_FIELD_NUMBER

      public static final int OBJECT_METADATA_REPORT_OPTIONS_FIELD_NUMBER
      See Also:
    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:
    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getReportFormatCase

      public ReportConfig.ReportFormatCase getReportFormatCase()
      Specified by:
      getReportFormatCase in interface ReportConfigOrBuilder
    • getReportKindCase

      public ReportConfig.ReportKindCase getReportKindCase()
      Specified by:
      getReportKindCase in interface ReportConfigOrBuilder
    • getName

      public String getName()
       name of resource. It will be of form
       projects/<project>/locations/<location>/reportConfigs/<report-config-id>.
       
      string name = 1;
      Specified by:
      getName in interface ReportConfigOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       name of resource. It will be of form
       projects/<project>/locations/<location>/reportConfigs/<report-config-id>.
       
      string name = 1;
      Specified by:
      getNameBytes in interface ReportConfigOrBuilder
      Returns:
      The bytes for name.
    • hasCreateTime

      public boolean hasCreateTime()
       Output only. [Output only] Create time stamp
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ReportConfigOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. [Output only] Create time stamp
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ReportConfigOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. [Output only] Create time stamp
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ReportConfigOrBuilder
    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. [Output only] Update time stamp
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface ReportConfigOrBuilder
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. [Output only] Update time stamp
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface ReportConfigOrBuilder
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. [Output only] Update time stamp
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface ReportConfigOrBuilder
    • hasFrequencyOptions

      public boolean hasFrequencyOptions()
       The frequency of report generation.
       
      .google.cloud.storageinsights.v1.FrequencyOptions frequency_options = 5;
      Specified by:
      hasFrequencyOptions in interface ReportConfigOrBuilder
      Returns:
      Whether the frequencyOptions field is set.
    • getFrequencyOptions

      public FrequencyOptions getFrequencyOptions()
       The frequency of report generation.
       
      .google.cloud.storageinsights.v1.FrequencyOptions frequency_options = 5;
      Specified by:
      getFrequencyOptions in interface ReportConfigOrBuilder
      Returns:
      The frequencyOptions.
    • getFrequencyOptionsOrBuilder

      public FrequencyOptionsOrBuilder getFrequencyOptionsOrBuilder()
       The frequency of report generation.
       
      .google.cloud.storageinsights.v1.FrequencyOptions frequency_options = 5;
      Specified by:
      getFrequencyOptionsOrBuilder in interface ReportConfigOrBuilder
    • hasCsvOptions

      public boolean hasCsvOptions()
       Options for CSV formatted reports.
       
      .google.cloud.storageinsights.v1.CSVOptions csv_options = 6;
      Specified by:
      hasCsvOptions in interface ReportConfigOrBuilder
      Returns:
      Whether the csvOptions field is set.
    • getCsvOptions

      public CSVOptions getCsvOptions()
       Options for CSV formatted reports.
       
      .google.cloud.storageinsights.v1.CSVOptions csv_options = 6;
      Specified by:
      getCsvOptions in interface ReportConfigOrBuilder
      Returns:
      The csvOptions.
    • getCsvOptionsOrBuilder

      public CSVOptionsOrBuilder getCsvOptionsOrBuilder()
       Options for CSV formatted reports.
       
      .google.cloud.storageinsights.v1.CSVOptions csv_options = 6;
      Specified by:
      getCsvOptionsOrBuilder in interface ReportConfigOrBuilder
    • hasParquetOptions

      public boolean hasParquetOptions()
       Options for Parquet formatted reports.
       
      .google.cloud.storageinsights.v1.ParquetOptions parquet_options = 7;
      Specified by:
      hasParquetOptions in interface ReportConfigOrBuilder
      Returns:
      Whether the parquetOptions field is set.
    • getParquetOptions

      public ParquetOptions getParquetOptions()
       Options for Parquet formatted reports.
       
      .google.cloud.storageinsights.v1.ParquetOptions parquet_options = 7;
      Specified by:
      getParquetOptions in interface ReportConfigOrBuilder
      Returns:
      The parquetOptions.
    • getParquetOptionsOrBuilder

      public ParquetOptionsOrBuilder getParquetOptionsOrBuilder()
       Options for Parquet formatted reports.
       
      .google.cloud.storageinsights.v1.ParquetOptions parquet_options = 7;
      Specified by:
      getParquetOptionsOrBuilder in interface ReportConfigOrBuilder
    • hasObjectMetadataReportOptions

      public boolean hasObjectMetadataReportOptions()
       Report for exporting object metadata.
       
      .google.cloud.storageinsights.v1.ObjectMetadataReportOptions object_metadata_report_options = 8;
      Specified by:
      hasObjectMetadataReportOptions in interface ReportConfigOrBuilder
      Returns:
      Whether the objectMetadataReportOptions field is set.
    • getObjectMetadataReportOptions

      public ObjectMetadataReportOptions getObjectMetadataReportOptions()
       Report for exporting object metadata.
       
      .google.cloud.storageinsights.v1.ObjectMetadataReportOptions object_metadata_report_options = 8;
      Specified by:
      getObjectMetadataReportOptions in interface ReportConfigOrBuilder
      Returns:
      The objectMetadataReportOptions.
    • getObjectMetadataReportOptionsOrBuilder

      public ObjectMetadataReportOptionsOrBuilder getObjectMetadataReportOptionsOrBuilder()
       Report for exporting object metadata.
       
      .google.cloud.storageinsights.v1.ObjectMetadataReportOptions object_metadata_report_options = 8;
      Specified by:
      getObjectMetadataReportOptionsOrBuilder in interface ReportConfigOrBuilder
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: ReportConfigOrBuilder
       Labels as key value pairs
       
      map<string, string> labels = 10;
      Specified by:
      getLabelsCount in interface ReportConfigOrBuilder
    • containsLabels

      public boolean containsLabels(String key)
       Labels as key value pairs
       
      map<string, string> labels = 10;
      Specified by:
      containsLabels in interface ReportConfigOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface ReportConfigOrBuilder
    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Labels as key value pairs
       
      map<string, string> labels = 10;
      Specified by:
      getLabelsMap in interface ReportConfigOrBuilder
    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Labels as key value pairs
       
      map<string, string> labels = 10;
      Specified by:
      getLabelsOrDefault in interface ReportConfigOrBuilder
    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Labels as key value pairs
       
      map<string, string> labels = 10;
      Specified by:
      getLabelsOrThrow in interface ReportConfigOrBuilder
    • getDisplayName

      public String getDisplayName()
       User provided display name which can be empty and limited to 256 characters
       that is editable.
       
      string display_name = 11;
      Specified by:
      getDisplayName in interface ReportConfigOrBuilder
      Returns:
      The displayName.
    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       User provided display name which can be empty and limited to 256 characters
       that is editable.
       
      string display_name = 11;
      Specified by:
      getDisplayNameBytes in interface ReportConfigOrBuilder
      Returns:
      The bytes for displayName.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 ReportConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static ReportConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ReportConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ReportConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ReportConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ReportConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

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

      public static ReportConfig.Builder newBuilder()
    • newBuilder

      public static ReportConfig.Builder newBuilder(ReportConfig prototype)
    • toBuilder

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

      protected ReportConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ReportConfig getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ReportConfig> parser()
    • getParserForType

      public com.google.protobuf.Parser<ReportConfig> 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.GeneratedMessage
    • getDefaultInstanceForType

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