Class ReportConfig.Builder (0.16.0)

public static final class ReportConfig.Builder extends GeneratedMessageV3.Builder<ReportConfig.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReportConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReportConfig.Builder
Overrides

build()

public ReportConfig build()
Returns
Type Description
ReportConfig

buildPartial()

public ReportConfig buildPartial()
Returns
Type Description
ReportConfig

clear()

public ReportConfig.Builder clear()
Returns
Type Description
ReportConfig.Builder
Overrides

clearCreateTime()

public ReportConfig.Builder clearCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type Description
ReportConfig.Builder

clearCsvOptions()

public ReportConfig.Builder clearCsvOptions()

Options for CSV formatted reports.

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

Returns
Type Description
ReportConfig.Builder

clearDisplayName()

public ReportConfig.Builder clearDisplayName()

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

string display_name = 11;

Returns
Type Description
ReportConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReportConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ReportConfig.Builder
Overrides

clearFrequencyOptions()

public ReportConfig.Builder clearFrequencyOptions()

The frequency of report generation.

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

Returns
Type Description
ReportConfig.Builder

clearLabels()

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

clearName()

public ReportConfig.Builder clearName()

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

string name = 1;

Returns
Type Description
ReportConfig.Builder

This builder for chaining.

clearObjectMetadataReportOptions()

public ReportConfig.Builder clearObjectMetadataReportOptions()

Report for exporting object metadata.

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

Returns
Type Description
ReportConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ReportConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ReportConfig.Builder
Overrides

clearParquetOptions()

public ReportConfig.Builder clearParquetOptions()

Options for Parquet formatted reports.

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

Returns
Type Description
ReportConfig.Builder

clearReportFormat()

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

clearReportKind()

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

clearUpdateTime()

public ReportConfig.Builder clearUpdateTime()

Output only. [Output only] Update time stamp

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

Returns
Type Description
ReportConfig.Builder

clone()

public ReportConfig.Builder clone()
Returns
Type Description
ReportConfig.Builder
Overrides

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

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. [Output only] Create time stamp

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

Returns
Type Description
Builder

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.

getCsvOptionsBuilder()

public CSVOptions.Builder getCsvOptionsBuilder()

Options for CSV formatted reports.

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

Returns
Type Description
CSVOptions.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getFrequencyOptionsBuilder()

public FrequencyOptions.Builder getFrequencyOptionsBuilder()

The frequency of report generation.

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

Returns
Type Description
FrequencyOptions.Builder

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,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.

getObjectMetadataReportOptionsBuilder()

public ObjectMetadataReportOptions.Builder getObjectMetadataReportOptionsBuilder()

Report for exporting object metadata.

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

Returns
Type Description
ObjectMetadataReportOptions.Builder

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.

getParquetOptionsBuilder()

public ParquetOptions.Builder getParquetOptionsBuilder()

Options for Parquet formatted reports.

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

Returns
Type Description
ParquetOptions.Builder

getParquetOptionsOrBuilder()

public ParquetOptionsOrBuilder getParquetOptionsOrBuilder()

Options for Parquet formatted reports.

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

Returns
Type Description
ParquetOptionsOrBuilder

getReportFormatCase()

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

getReportKindCase()

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

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. [Output only] Update time stamp

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

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ReportConfig.Builder mergeCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ReportConfig.Builder

mergeCsvOptions(CSVOptions value)

public ReportConfig.Builder mergeCsvOptions(CSVOptions value)

Options for CSV formatted reports.

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

Parameter
Name Description
value CSVOptions
Returns
Type Description
ReportConfig.Builder

mergeFrequencyOptions(FrequencyOptions value)

public ReportConfig.Builder mergeFrequencyOptions(FrequencyOptions value)

The frequency of report generation.

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

Parameter
Name Description
value FrequencyOptions
Returns
Type Description
ReportConfig.Builder

mergeFrom(ReportConfig other)

public ReportConfig.Builder mergeFrom(ReportConfig other)
Parameter
Name Description
other ReportConfig
Returns
Type Description
ReportConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReportConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReportConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ReportConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ReportConfig.Builder
Overrides

mergeObjectMetadataReportOptions(ObjectMetadataReportOptions value)

public ReportConfig.Builder mergeObjectMetadataReportOptions(ObjectMetadataReportOptions value)

Report for exporting object metadata.

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

Parameter
Name Description
value ObjectMetadataReportOptions
Returns
Type Description
ReportConfig.Builder

mergeParquetOptions(ParquetOptions value)

public ReportConfig.Builder mergeParquetOptions(ParquetOptions value)

Options for Parquet formatted reports.

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

Parameter
Name Description
value ParquetOptions
Returns
Type Description
ReportConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReportConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReportConfig.Builder
Overrides

mergeUpdateTime(Timestamp value)

public ReportConfig.Builder mergeUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ReportConfig.Builder

putAllLabels(Map<String,String> values)

public ReportConfig.Builder putAllLabels(Map<String,String> values)

Labels as key value pairs

map<string, string> labels = 10;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ReportConfig.Builder

putLabels(String key, String value)

public ReportConfig.Builder putLabels(String key, String value)

Labels as key value pairs

map<string, string> labels = 10;

Parameters
Name Description
key String
value String
Returns
Type Description
ReportConfig.Builder

removeLabels(String key)

public ReportConfig.Builder removeLabels(String key)

Labels as key value pairs

map<string, string> labels = 10;

Parameter
Name Description
key String
Returns
Type Description
ReportConfig.Builder

setCreateTime(Timestamp value)

public ReportConfig.Builder setCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ReportConfig.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ReportConfig.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ReportConfig.Builder

setCsvOptions(CSVOptions value)

public ReportConfig.Builder setCsvOptions(CSVOptions value)

Options for CSV formatted reports.

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

Parameter
Name Description
value CSVOptions
Returns
Type Description
ReportConfig.Builder

setCsvOptions(CSVOptions.Builder builderForValue)

public ReportConfig.Builder setCsvOptions(CSVOptions.Builder builderForValue)

Options for CSV formatted reports.

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

Parameter
Name Description
builderForValue CSVOptions.Builder
Returns
Type Description
ReportConfig.Builder

setDisplayName(String value)

public ReportConfig.Builder setDisplayName(String value)

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

string display_name = 11;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
ReportConfig.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ReportConfig.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 11;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
ReportConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReportConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReportConfig.Builder
Overrides

setFrequencyOptions(FrequencyOptions value)

public ReportConfig.Builder setFrequencyOptions(FrequencyOptions value)

The frequency of report generation.

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

Parameter
Name Description
value FrequencyOptions
Returns
Type Description
ReportConfig.Builder

setFrequencyOptions(FrequencyOptions.Builder builderForValue)

public ReportConfig.Builder setFrequencyOptions(FrequencyOptions.Builder builderForValue)

The frequency of report generation.

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

Parameter
Name Description
builderForValue FrequencyOptions.Builder
Returns
Type Description
ReportConfig.Builder

setName(String value)

public ReportConfig.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ReportConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ReportConfig.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ReportConfig.Builder

This builder for chaining.

setObjectMetadataReportOptions(ObjectMetadataReportOptions value)

public ReportConfig.Builder setObjectMetadataReportOptions(ObjectMetadataReportOptions value)

Report for exporting object metadata.

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

Parameter
Name Description
value ObjectMetadataReportOptions
Returns
Type Description
ReportConfig.Builder

setObjectMetadataReportOptions(ObjectMetadataReportOptions.Builder builderForValue)

public ReportConfig.Builder setObjectMetadataReportOptions(ObjectMetadataReportOptions.Builder builderForValue)

Report for exporting object metadata.

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

Parameter
Name Description
builderForValue ObjectMetadataReportOptions.Builder
Returns
Type Description
ReportConfig.Builder

setParquetOptions(ParquetOptions value)

public ReportConfig.Builder setParquetOptions(ParquetOptions value)

Options for Parquet formatted reports.

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

Parameter
Name Description
value ParquetOptions
Returns
Type Description
ReportConfig.Builder

setParquetOptions(ParquetOptions.Builder builderForValue)

public ReportConfig.Builder setParquetOptions(ParquetOptions.Builder builderForValue)

Options for Parquet formatted reports.

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

Parameter
Name Description
builderForValue ParquetOptions.Builder
Returns
Type Description
ReportConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReportConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReportConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ReportConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReportConfig.Builder
Overrides

setUpdateTime(Timestamp value)

public ReportConfig.Builder setUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ReportConfig.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public ReportConfig.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ReportConfig.Builder