Class Operation.Builder (1.29.0)

public static final class Operation.Builder extends GeneratedMessageV3.Builder<Operation.Builder> implements OperationOrBuilder

Represents information regarding an operation.

Protobuf type google.api.servicecontrol.v1.Operation

Implements

OperationOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllExtensions(Iterable<? extends Any> values)

public Operation.Builder addAllExtensions(Iterable<? extends Any> values)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
NameDescription
valuesIterable<? extends com.google.protobuf.Any>
Returns
TypeDescription
Operation.Builder

addAllLogEntries(Iterable<? extends LogEntry> values)

public Operation.Builder addAllLogEntries(Iterable<? extends LogEntry> values)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameter
NameDescription
valuesIterable<? extends com.google.api.servicecontrol.v1.LogEntry>
Returns
TypeDescription
Operation.Builder

addAllMetricValueSets(Iterable<? extends MetricValueSet> values)

public Operation.Builder addAllMetricValueSets(Iterable<? extends MetricValueSet> values)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameter
NameDescription
valuesIterable<? extends com.google.api.servicecontrol.v1.MetricValueSet>
Returns
TypeDescription
Operation.Builder

addExtensions(Any value)

public Operation.Builder addExtensions(Any value)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
NameDescription
valueAny
Returns
TypeDescription
Operation.Builder

addExtensions(Any.Builder builderForValue)

public Operation.Builder addExtensions(Any.Builder builderForValue)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Operation.Builder

addExtensions(int index, Any value)

public Operation.Builder addExtensions(int index, Any value)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameters
NameDescription
indexint
valueAny
Returns
TypeDescription
Operation.Builder

addExtensions(int index, Any.Builder builderForValue)

public Operation.Builder addExtensions(int index, Any.Builder builderForValue)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameters
NameDescription
indexint
builderForValueBuilder
Returns
TypeDescription
Operation.Builder

addExtensionsBuilder()

public Any.Builder addExtensionsBuilder()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
TypeDescription
Builder

addExtensionsBuilder(int index)

public Any.Builder addExtensionsBuilder(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
NameDescription
indexint
Returns
TypeDescription
Builder

addLogEntries(LogEntry value)

public Operation.Builder addLogEntries(LogEntry value)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameter
NameDescription
valueLogEntry
Returns
TypeDescription
Operation.Builder

addLogEntries(LogEntry.Builder builderForValue)

public Operation.Builder addLogEntries(LogEntry.Builder builderForValue)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameter
NameDescription
builderForValueLogEntry.Builder
Returns
TypeDescription
Operation.Builder

addLogEntries(int index, LogEntry value)

public Operation.Builder addLogEntries(int index, LogEntry value)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameters
NameDescription
indexint
valueLogEntry
Returns
TypeDescription
Operation.Builder

addLogEntries(int index, LogEntry.Builder builderForValue)

public Operation.Builder addLogEntries(int index, LogEntry.Builder builderForValue)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameters
NameDescription
indexint
builderForValueLogEntry.Builder
Returns
TypeDescription
Operation.Builder

addLogEntriesBuilder()

public LogEntry.Builder addLogEntriesBuilder()

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Returns
TypeDescription
LogEntry.Builder

addLogEntriesBuilder(int index)

public LogEntry.Builder addLogEntriesBuilder(int index)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
LogEntry.Builder

addMetricValueSets(MetricValueSet value)

public Operation.Builder addMetricValueSets(MetricValueSet value)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameter
NameDescription
valueMetricValueSet
Returns
TypeDescription
Operation.Builder

addMetricValueSets(MetricValueSet.Builder builderForValue)

public Operation.Builder addMetricValueSets(MetricValueSet.Builder builderForValue)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameter
NameDescription
builderForValueMetricValueSet.Builder
Returns
TypeDescription
Operation.Builder

addMetricValueSets(int index, MetricValueSet value)

public Operation.Builder addMetricValueSets(int index, MetricValueSet value)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameters
NameDescription
indexint
valueMetricValueSet
Returns
TypeDescription
Operation.Builder

addMetricValueSets(int index, MetricValueSet.Builder builderForValue)

public Operation.Builder addMetricValueSets(int index, MetricValueSet.Builder builderForValue)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameters
NameDescription
indexint
builderForValueMetricValueSet.Builder
Returns
TypeDescription
Operation.Builder

addMetricValueSetsBuilder()

public MetricValueSet.Builder addMetricValueSetsBuilder()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Returns
TypeDescription
MetricValueSet.Builder

addMetricValueSetsBuilder(int index)

public MetricValueSet.Builder addMetricValueSetsBuilder(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricValueSet.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Operation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Operation.Builder
Overrides

build()

public Operation build()
Returns
TypeDescription
Operation

buildPartial()

public Operation buildPartial()
Returns
TypeDescription
Operation

clear()

public Operation.Builder clear()
Returns
TypeDescription
Operation.Builder
Overrides

clearConsumerId()

public Operation.Builder clearConsumerId()

Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer.

  • This can be in one of the following formats:
    • project:PROJECT_ID,
    • project_number:PROJECT_NUMBER,
    • projects/PROJECT_ID or PROJECT_NUMBER,
    • folders/FOLDER_NUMBER,
    • organizations/ORGANIZATION_NUMBER,
    • api_key:API_KEY.

string consumer_id = 3;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearEndTime()

public Operation.Builder clearEndTime()

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

.google.protobuf.Timestamp end_time = 5;

Returns
TypeDescription
Operation.Builder

clearExtensions()

public Operation.Builder clearExtensions()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
TypeDescription
Operation.Builder

clearField(Descriptors.FieldDescriptor field)

public Operation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Operation.Builder
Overrides

clearImportance()

public Operation.Builder clearImportance()

DO NOT USE. This is an experimental field.

.google.api.servicecontrol.v1.Operation.Importance importance = 11;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearLabels()

public Operation.Builder clearLabels()
Returns
TypeDescription
Operation.Builder

clearLogEntries()

public Operation.Builder clearLogEntries()

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Returns
TypeDescription
Operation.Builder

clearMetricValueSets()

public Operation.Builder clearMetricValueSets()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Returns
TypeDescription
Operation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Operation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Operation.Builder
Overrides

clearOperationId()

public Operation.Builder clearOperationId()

Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id.

UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.

string operation_id = 1;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearOperationName()

public Operation.Builder clearOperationName()

Fully qualified name of the operation. Reserved for future use.

string operation_name = 2;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearStartTime()

public Operation.Builder clearStartTime()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
Operation.Builder

clone()

public Operation.Builder clone()
Returns
TypeDescription
Operation.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getConsumerId()

public String getConsumerId()

Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer.

  • This can be in one of the following formats:
    • project:PROJECT_ID,
    • project_number:PROJECT_NUMBER,
    • projects/PROJECT_ID or PROJECT_NUMBER,
    • folders/FOLDER_NUMBER,
    • organizations/ORGANIZATION_NUMBER,
    • api_key:API_KEY.

string consumer_id = 3;

Returns
TypeDescription
String

The consumerId.

getConsumerIdBytes()

public ByteString getConsumerIdBytes()

Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer.

  • This can be in one of the following formats:
    • project:PROJECT_ID,
    • project_number:PROJECT_NUMBER,
    • projects/PROJECT_ID or PROJECT_NUMBER,
    • folders/FOLDER_NUMBER,
    • organizations/ORGANIZATION_NUMBER,
    • api_key:API_KEY.

string consumer_id = 3;

Returns
TypeDescription
ByteString

The bytes for consumerId.

getDefaultInstanceForType()

public Operation getDefaultInstanceForType()
Returns
TypeDescription
Operation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndTime()

public Timestamp getEndTime()

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

.google.protobuf.Timestamp end_time = 5;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

.google.protobuf.Timestamp end_time = 5;

Returns
TypeDescription
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

.google.protobuf.Timestamp end_time = 5;

Returns
TypeDescription
TimestampOrBuilder

getExtensions(int index)

public Any getExtensions(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
NameDescription
indexint
Returns
TypeDescription
Any

getExtensionsBuilder(int index)

public Any.Builder getExtensionsBuilder(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
NameDescription
indexint
Returns
TypeDescription
Builder

getExtensionsBuilderList()

public List<Any.Builder> getExtensionsBuilderList()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
TypeDescription
List<Builder>

getExtensionsCount()

public int getExtensionsCount()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
TypeDescription
int

getExtensionsList()

public List<Any> getExtensionsList()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
TypeDescription
List<Any>

getExtensionsOrBuilder(int index)

public AnyOrBuilder getExtensionsOrBuilder(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
NameDescription
indexint
Returns
TypeDescription
AnyOrBuilder

getExtensionsOrBuilderList()

public List<? extends AnyOrBuilder> getExtensionsOrBuilderList()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
TypeDescription
List<? extends com.google.protobuf.AnyOrBuilder>

getImportance()

public Operation.Importance getImportance()

DO NOT USE. This is an experimental field.

.google.api.servicecontrol.v1.Operation.Importance importance = 11;

Returns
TypeDescription
Operation.Importance

The importance.

getImportanceValue()

public int getImportanceValue()

DO NOT USE. This is an experimental field.

.google.api.servicecontrol.v1.Operation.Importance importance = 11;

Returns
TypeDescription
int

The enum numeric value on the wire for importance.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

map<string, string> labels = 6;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

map<string, string> labels = 6;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

map<string, string> labels = 6;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLogEntries(int index)

public LogEntry getLogEntries(int index)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
LogEntry

getLogEntriesBuilder(int index)

public LogEntry.Builder getLogEntriesBuilder(int index)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
LogEntry.Builder

getLogEntriesBuilderList()

public List<LogEntry.Builder> getLogEntriesBuilderList()

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Returns
TypeDescription
List<Builder>

getLogEntriesCount()

public int getLogEntriesCount()

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Returns
TypeDescription
int

getLogEntriesList()

public List<LogEntry> getLogEntriesList()

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Returns
TypeDescription
List<LogEntry>

getLogEntriesOrBuilder(int index)

public LogEntryOrBuilder getLogEntriesOrBuilder(int index)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
LogEntryOrBuilder

getLogEntriesOrBuilderList()

public List<? extends LogEntryOrBuilder> getLogEntriesOrBuilderList()

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Returns
TypeDescription
List<? extends com.google.api.servicecontrol.v1.LogEntryOrBuilder>

getMetricValueSets(int index)

public MetricValueSet getMetricValueSets(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricValueSet

getMetricValueSetsBuilder(int index)

public MetricValueSet.Builder getMetricValueSetsBuilder(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricValueSet.Builder

getMetricValueSetsBuilderList()

public List<MetricValueSet.Builder> getMetricValueSetsBuilderList()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Returns
TypeDescription
List<Builder>

getMetricValueSetsCount()

public int getMetricValueSetsCount()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Returns
TypeDescription
int

getMetricValueSetsList()

public List<MetricValueSet> getMetricValueSetsList()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Returns
TypeDescription
List<MetricValueSet>

getMetricValueSetsOrBuilder(int index)

public MetricValueSetOrBuilder getMetricValueSetsOrBuilder(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricValueSetOrBuilder

getMetricValueSetsOrBuilderList()

public List<? extends MetricValueSetOrBuilder> getMetricValueSetsOrBuilderList()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Returns
TypeDescription
List<? extends com.google.api.servicecontrol.v1.MetricValueSetOrBuilder>

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getOperationId()

public String getOperationId()

Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id.

UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.

string operation_id = 1;

Returns
TypeDescription
String

The operationId.

getOperationIdBytes()

public ByteString getOperationIdBytes()

Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id.

UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.

string operation_id = 1;

Returns
TypeDescription
ByteString

The bytes for operationId.

getOperationName()

public String getOperationName()

Fully qualified name of the operation. Reserved for future use.

string operation_name = 2;

Returns
TypeDescription
String

The operationName.

getOperationNameBytes()

public ByteString getOperationNameBytes()

Fully qualified name of the operation. Reserved for future use.

string operation_name = 2;

Returns
TypeDescription
ByteString

The bytes for operationName.

getStartTime()

public Timestamp getStartTime()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

.google.protobuf.Timestamp end_time = 5;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEndTime(Timestamp value)

public Operation.Builder mergeEndTime(Timestamp value)

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

.google.protobuf.Timestamp end_time = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Operation.Builder

mergeFrom(Operation other)

public Operation.Builder mergeFrom(Operation other)
Parameter
NameDescription
otherOperation
Returns
TypeDescription
Operation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Operation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Operation.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Operation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Operation.Builder
Overrides

mergeStartTime(Timestamp value)

public Operation.Builder mergeStartTime(Timestamp value)

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Operation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Operation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Operation.Builder
Overrides

putAllLabels(Map<String,String> values)

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

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

map<string, string> labels = 6;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Operation.Builder

putLabels(String key, String value)

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

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

map<string, string> labels = 6;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Operation.Builder

removeExtensions(int index)

public Operation.Builder removeExtensions(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
NameDescription
indexint
Returns
TypeDescription
Operation.Builder

removeLabels(String key)

public Operation.Builder removeLabels(String key)

Labels describing the operation. Only the following labels are allowed:

  • Labels describing monitored resources as defined in the service configuration.
  • Default labels of metric values. When specified, labels defined in the metric value override these default.
  • The following labels defined by Google Cloud Platform:
    • cloud.googleapis.com/location describing the location where the operation happened,
    • servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
    • servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
    • servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
Operation.Builder

removeLogEntries(int index)

public Operation.Builder removeLogEntries(int index)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
Operation.Builder

removeMetricValueSets(int index)

public Operation.Builder removeMetricValueSets(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
Operation.Builder

setConsumerId(String value)

public Operation.Builder setConsumerId(String value)

Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer.

  • This can be in one of the following formats:
    • project:PROJECT_ID,
    • project_number:PROJECT_NUMBER,
    • projects/PROJECT_ID or PROJECT_NUMBER,
    • folders/FOLDER_NUMBER,
    • organizations/ORGANIZATION_NUMBER,
    • api_key:API_KEY.

string consumer_id = 3;

Parameter
NameDescription
valueString

The consumerId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setConsumerIdBytes(ByteString value)

public Operation.Builder setConsumerIdBytes(ByteString value)

Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer.

  • This can be in one of the following formats:
    • project:PROJECT_ID,
    • project_number:PROJECT_NUMBER,
    • projects/PROJECT_ID or PROJECT_NUMBER,
    • folders/FOLDER_NUMBER,
    • organizations/ORGANIZATION_NUMBER,
    • api_key:API_KEY.

string consumer_id = 3;

Parameter
NameDescription
valueByteString

The bytes for consumerId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setEndTime(Timestamp value)

public Operation.Builder setEndTime(Timestamp value)

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

.google.protobuf.Timestamp end_time = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Operation.Builder

setEndTime(Timestamp.Builder builderForValue)

public Operation.Builder setEndTime(Timestamp.Builder builderForValue)

End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

.google.protobuf.Timestamp end_time = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Operation.Builder

setExtensions(int index, Any value)

public Operation.Builder setExtensions(int index, Any value)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameters
NameDescription
indexint
valueAny
Returns
TypeDescription
Operation.Builder

setExtensions(int index, Any.Builder builderForValue)

public Operation.Builder setExtensions(int index, Any.Builder builderForValue)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameters
NameDescription
indexint
builderForValueBuilder
Returns
TypeDescription
Operation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Operation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Operation.Builder
Overrides

setImportance(Operation.Importance value)

public Operation.Builder setImportance(Operation.Importance value)

DO NOT USE. This is an experimental field.

.google.api.servicecontrol.v1.Operation.Importance importance = 11;

Parameter
NameDescription
valueOperation.Importance

The importance to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setImportanceValue(int value)

public Operation.Builder setImportanceValue(int value)

DO NOT USE. This is an experimental field.

.google.api.servicecontrol.v1.Operation.Importance importance = 11;

Parameter
NameDescription
valueint

The enum numeric value on the wire for importance to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setLogEntries(int index, LogEntry value)

public Operation.Builder setLogEntries(int index, LogEntry value)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameters
NameDescription
indexint
valueLogEntry
Returns
TypeDescription
Operation.Builder

setLogEntries(int index, LogEntry.Builder builderForValue)

public Operation.Builder setLogEntries(int index, LogEntry.Builder builderForValue)

Represents information to be logged.

repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

Parameters
NameDescription
indexint
builderForValueLogEntry.Builder
Returns
TypeDescription
Operation.Builder

setMetricValueSets(int index, MetricValueSet value)

public Operation.Builder setMetricValueSets(int index, MetricValueSet value)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameters
NameDescription
indexint
valueMetricValueSet
Returns
TypeDescription
Operation.Builder

setMetricValueSets(int index, MetricValueSet.Builder builderForValue)

public Operation.Builder setMetricValueSets(int index, MetricValueSet.Builder builderForValue)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

Parameters
NameDescription
indexint
builderForValueMetricValueSet.Builder
Returns
TypeDescription
Operation.Builder

setOperationId(String value)

public Operation.Builder setOperationId(String value)

Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id.

UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.

string operation_id = 1;

Parameter
NameDescription
valueString

The operationId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setOperationIdBytes(ByteString value)

public Operation.Builder setOperationIdBytes(ByteString value)

Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id.

UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.

string operation_id = 1;

Parameter
NameDescription
valueByteString

The bytes for operationId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setOperationName(String value)

public Operation.Builder setOperationName(String value)

Fully qualified name of the operation. Reserved for future use.

string operation_name = 2;

Parameter
NameDescription
valueString

The operationName to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setOperationNameBytes(ByteString value)

public Operation.Builder setOperationNameBytes(ByteString value)

Fully qualified name of the operation. Reserved for future use.

string operation_name = 2;

Parameter
NameDescription
valueByteString

The bytes for operationName to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

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

public Operation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Operation.Builder
Overrides

setStartTime(Timestamp value)

public Operation.Builder setStartTime(Timestamp value)

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Operation.Builder

setStartTime(Timestamp.Builder builderForValue)

public Operation.Builder setStartTime(Timestamp.Builder builderForValue)

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Operation.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Operation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Operation.Builder
Overrides