Class ReportConfig (0.21.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

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CSV_OPTIONS_FIELD_NUMBER

public static final int CSV_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

FREQUENCY_OPTIONS_FIELD_NUMBER

public static final int FREQUENCY_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OBJECT_METADATA_REPORT_OPTIONS_FIELD_NUMBER

public static final int OBJECT_METADATA_REPORT_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

PARQUET_OPTIONS_FIELD_NUMBER

public static final int PARQUET_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReportConfig getDefaultInstance()
Returns
TypeDescription
ReportConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReportConfig.Builder newBuilder()
Returns
TypeDescription
ReportConfig.Builder

newBuilder(ReportConfig prototype)

public static ReportConfig.Builder newBuilder(ReportConfig prototype)
Parameter
NameDescription
prototypeReportConfig
Returns
TypeDescription
ReportConfig.Builder

parseDelimitedFrom(InputStream input)

public static ReportConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReportConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReportConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReportConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReportConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReportConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReportConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReportConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReportConfig> parser()
Returns
TypeDescription
Parser<ReportConfig>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getCsvOptions()

public CSVOptions getCsvOptions()

Options for CSV formatted reports.

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

Returns
TypeDescription
CSVOptions

The csvOptions.

getCsvOptionsOrBuilder()

public CSVOptionsOrBuilder getCsvOptionsOrBuilder()

Options for CSV formatted reports.

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

Returns
TypeDescription
CSVOptionsOrBuilder

getDefaultInstanceForType()

public ReportConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

getFrequencyOptions()

public FrequencyOptions getFrequencyOptions()

The frequency of report generation.

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

Returns
TypeDescription
FrequencyOptions

The frequencyOptions.

getFrequencyOptionsOrBuilder()

public FrequencyOptionsOrBuilder getFrequencyOptionsOrBuilder()

The frequency of report generation.

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

Returns
TypeDescription
FrequencyOptionsOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 10;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 10;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ObjectMetadataReportOptions

The objectMetadataReportOptions.

getObjectMetadataReportOptionsOrBuilder()

public ObjectMetadataReportOptionsOrBuilder getObjectMetadataReportOptionsOrBuilder()

Report for exporting object metadata.

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

Returns
TypeDescription
ObjectMetadataReportOptionsOrBuilder

getParquetOptions()

public ParquetOptions getParquetOptions()

Options for Parquet formatted reports.

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

Returns
TypeDescription
ParquetOptions

The parquetOptions.

getParquetOptionsOrBuilder()

public ParquetOptionsOrBuilder getParquetOptionsOrBuilder()

Options for Parquet formatted reports.

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

Returns
TypeDescription
ParquetOptionsOrBuilder

getParserForType()

public Parser<ReportConfig> getParserForType()
Returns
TypeDescription
Parser<ReportConfig>
Overrides

getReportFormatCase()

public ReportConfig.ReportFormatCase getReportFormatCase()
Returns
TypeDescription
ReportConfig.ReportFormatCase

getReportKindCase()

public ReportConfig.ReportKindCase getReportKindCase()
Returns
TypeDescription
ReportConfig.ReportKindCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReportConfig.Builder newBuilderForType()
Returns
TypeDescription
ReportConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReportConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReportConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReportConfig.Builder toBuilder()
Returns
TypeDescription
ReportConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException