Class ReportConfig (0.24.0) 

public final class ReportConfig extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReportConfig

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CSV_OPTIONS_FIELD_NUMBER

public static final int CSV_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

FREQUENCY_OPTIONS_FIELD_NUMBER

public static final int FREQUENCY_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OBJECT_METADATA_REPORT_OPTIONS_FIELD_NUMBER

public static final int OBJECT_METADATA_REPORT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

PARQUET_OPTIONS_FIELD_NUMBER

public static final int PARQUET_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReportConfig getDefaultInstance()
Returns
Type Description
ReportConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ReportConfig.Builder newBuilder()
Returns
Type Description
ReportConfig.Builder

newBuilder(ReportConfig prototype)

public static ReportConfig.Builder newBuilder(ReportConfig prototype)
Parameter
Name Description
prototype ReportConfig
Returns
Type Description
ReportConfig.Builder

parseDelimitedFrom(InputStream input)

public static ReportConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReportConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReportConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReportConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReportConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReportConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReportConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReportConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReportConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReportConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReportConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReportConfig> parser()
Returns
Type Description
Parser<ReportConfig>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 10;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCsvOptions()

public CSVOptions getCsvOptions()

Options for CSV formatted reports.

.google.cloud.storageinsights.v1.CSVOptions csv_options = 6;

Returns
Type Description
CSVOptions

The csvOptions.

getCsvOptionsOrBuilder()

public CSVOptionsOrBuilder getCsvOptionsOrBuilder()

Options for CSV formatted reports.

.google.cloud.storageinsights.v1.CSVOptions csv_options = 6;

Returns
Type Description
CSVOptionsOrBuilder

getDefaultInstanceForType()

public ReportConfig getDefaultInstanceForType()
Returns
Type Description
ReportConfig

getDisplayName()

public String getDisplayName()

User provided display name which can be empty and limited to 256 characters that is editable.

string display_name = 11;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User provided display name which can be empty and limited to 256 characters that is editable.

string display_name = 11;

Returns
Type Description
ByteString

The bytes for displayName.

getFrequencyOptions()

public FrequencyOptions getFrequencyOptions()

The frequency of report generation.

.google.cloud.storageinsights.v1.FrequencyOptions frequency_options = 5;

Returns
Type Description
FrequencyOptions

The frequencyOptions.

getFrequencyOptionsOrBuilder()

public FrequencyOptionsOrBuilder getFrequencyOptionsOrBuilder()

The frequency of report generation.

.google.cloud.storageinsights.v1.FrequencyOptions frequency_options = 5;

Returns
Type Description
FrequencyOptionsOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 10;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 10;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 10;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 10;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

name of resource. It will be of form projects/<project>/locations/<location>/reportConfigs/<report-config-id>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

name of resource. It will be of form projects/<project>/locations/<location>/reportConfigs/<report-config-id>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getObjectMetadataReportOptions()

public ObjectMetadataReportOptions getObjectMetadataReportOptions()

Report for exporting object metadata.

.google.cloud.storageinsights.v1.ObjectMetadataReportOptions object_metadata_report_options = 8;

Returns
Type Description
ObjectMetadataReportOptions

The objectMetadataReportOptions.

getObjectMetadataReportOptionsOrBuilder()

public ObjectMetadataReportOptionsOrBuilder getObjectMetadataReportOptionsOrBuilder()

Report for exporting object metadata.

.google.cloud.storageinsights.v1.ObjectMetadataReportOptions object_metadata_report_options = 8;

Returns
Type Description
ObjectMetadataReportOptionsOrBuilder

getParquetOptions()

public ParquetOptions getParquetOptions()

Options for Parquet formatted reports.

.google.cloud.storageinsights.v1.ParquetOptions parquet_options = 7;

Returns
Type Description
ParquetOptions

The parquetOptions.

getParquetOptionsOrBuilder()

public ParquetOptionsOrBuilder getParquetOptionsOrBuilder()

Options for Parquet formatted reports.

.google.cloud.storageinsights.v1.ParquetOptions parquet_options = 7;

Returns
Type Description
ParquetOptionsOrBuilder

getParserForType()

public Parser<ReportConfig> getParserForType()
Returns
Type Description
Parser<ReportConfig>
Overrides

getReportFormatCase()

public ReportConfig.ReportFormatCase getReportFormatCase()
Returns
Type Description
ReportConfig.ReportFormatCase

getReportKindCase()

public ReportConfig.ReportKindCase getReportKindCase()
Returns
Type Description
ReportConfig.ReportKindCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasCsvOptions()

public boolean hasCsvOptions()

Options for CSV formatted reports.

.google.cloud.storageinsights.v1.CSVOptions csv_options = 6;

Returns
Type Description
boolean

Whether the csvOptions field is set.

hasFrequencyOptions()

public boolean hasFrequencyOptions()

The frequency of report generation.

.google.cloud.storageinsights.v1.FrequencyOptions frequency_options = 5;

Returns
Type Description
boolean

Whether the frequencyOptions field is set.

hasObjectMetadataReportOptions()

public boolean hasObjectMetadataReportOptions()

Report for exporting object metadata.

.google.cloud.storageinsights.v1.ObjectMetadataReportOptions object_metadata_report_options = 8;

Returns
Type Description
boolean

Whether the objectMetadataReportOptions field is set.

hasParquetOptions()

public boolean hasParquetOptions()

Options for Parquet formatted reports.

.google.cloud.storageinsights.v1.ParquetOptions parquet_options = 7;

Returns
Type Description
boolean

Whether the parquetOptions field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReportConfig.Builder newBuilderForType()
Returns
Type Description
ReportConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReportConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReportConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReportConfig.Builder toBuilder()
Returns
Type Description
ReportConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException