Class Operation.Builder (1.52.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Operation.Builder

Implements

OperationOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllExtensions(Iterable<? extends Any> values)

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

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
Name Description
values Iterable<? extends com.google.protobuf.Any>
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.api.servicecontrol.v1.LogEntry>
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.api.servicecontrol.v1.MetricValueSet>
Returns
Type Description
Operation.Builder

addExtensions(Any value)

public Operation.Builder addExtensions(Any value)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
Name Description
value Any
Returns
Type Description
Operation.Builder

addExtensions(Any.Builder builderForValue)

public Operation.Builder addExtensions(Any.Builder builderForValue)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Operation.Builder

addExtensions(int index, Any value)

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

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameters
Name Description
index int
value Any
Returns
Type Description
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
Name Description
index int
builderForValue Builder
Returns
Type Description
Operation.Builder

addExtensionsBuilder()

public Any.Builder addExtensionsBuilder()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
Type Description
Builder

addExtensionsBuilder(int index)

public Any.Builder addExtensionsBuilder(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
Name Description
index int
Returns
Type Description
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
Name Description
value LogEntry
Returns
Type Description
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
Name Description
builderForValue LogEntry.Builder
Returns
Type Description
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
Name Description
index int
value LogEntry
Returns
Type Description
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
Name Description
index int
builderForValue LogEntry.Builder
Returns
Type Description
Operation.Builder

addLogEntriesBuilder()

public LogEntry.Builder addLogEntriesBuilder()

Represents information to be logged.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
value MetricValueSet
Returns
Type Description
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
Name Description
builderForValue MetricValueSet.Builder
Returns
Type Description
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
Name Description
index int
value MetricValueSet
Returns
Type Description
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
Name Description
index int
builderForValue MetricValueSet.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
MetricValueSet.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Operation build()
Returns
Type Description
Operation

buildPartial()

public Operation buildPartial()
Returns
Type Description
Operation

clear()

public Operation.Builder clear()
Returns
Type Description
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
Type Description
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
Type Description
Operation.Builder

clearExtensions()

public Operation.Builder clearExtensions()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
Type Description
Operation.Builder

clearField(Descriptors.FieldDescriptor field)

public Operation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
Operation.Builder

This builder for chaining.

clearLabels()

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

clearLogEntries()

public Operation.Builder clearLogEntries()

Represents information to be logged.

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

Returns
Type Description
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
Type Description
Operation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Operation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
Operation.Builder

This builder for chaining.

clearStartTime()

public Operation.Builder clearStartTime()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Operation.Builder

clone()

public Operation.Builder clone()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for consumerId.

getDefaultInstanceForType()

public Operation getDefaultInstanceForType()
Returns
Type Description
Operation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

getExtensions(int index)

public Any getExtensions(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
Name Description
index int
Returns
Type Description
Any

getExtensionsBuilder(int index)

public Any.Builder getExtensionsBuilder(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
Name Description
index int
Returns
Type Description
Builder

getExtensionsBuilderList()

public List<Any.Builder> getExtensionsBuilderList()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
Type Description
List<Builder>

getExtensionsCount()

public int getExtensionsCount()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
Type Description
int

getExtensionsList()

public List<Any> getExtensionsList()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
Type Description
List<Any>

getExtensionsOrBuilder(int index)

public AnyOrBuilder getExtensionsOrBuilder(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
Name Description
index int
Returns
Type Description
AnyOrBuilder

getExtensionsOrBuilderList()

public List<? extends AnyOrBuilder> getExtensionsOrBuilderList()

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Returns
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for importance.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
String

getLogEntries(int index)

public LogEntry getLogEntries(int index)

Represents information to be logged.

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

Parameter
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
LogEntry.Builder

getLogEntriesBuilderList()

public List<LogEntry.Builder> getLogEntriesBuilderList()

Represents information to be logged.

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

Returns
Type Description
List<Builder>

getLogEntriesCount()

public int getLogEntriesCount()

Represents information to be logged.

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

Returns
Type Description
int

getLogEntriesList()

public List<LogEntry> getLogEntriesList()

Represents information to be logged.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
LogEntryOrBuilder

getLogEntriesOrBuilderList()

public List<? extends LogEntryOrBuilder> getLogEntriesOrBuilderList()

Represents information to be logged.

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

Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.api.servicecontrol.v1.MetricValueSetOrBuilder>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for operationId.

getOperationName()

public String getOperationName()

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

string operation_name = 2;

Returns
Type Description
String

The operationName.

getOperationNameBytes()

public ByteString getOperationNameBytes()

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

string operation_name = 2;

Returns
Type Description
ByteString

The bytes for operationName.

getStartTime()

public Timestamp getStartTime()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
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
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Required. Start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
boolean

Whether the startTime field is set.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
Operation.Builder

mergeFrom(Operation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Operation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
Operation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Operation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
values Map<String,String>
Returns
Type Description
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
Name Description
key String
value String
Returns
Type Description
Operation.Builder

removeExtensions(int index)

public Operation.Builder removeExtensions(int index)

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameter
Name Description
index int
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
value String

The consumerId to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for consumerId to set.
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
Operation.Builder

setExtensions(int index, Any value)

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

Unimplemented.

repeated .google.protobuf.Any extensions = 16;

Parameters
Name Description
index int
value Any
Returns
Type Description
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
Name Description
index int
builderForValue Builder
Returns
Type Description
Operation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Operation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value Operation.Importance

The importance to set.
Returns
Type Description
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
Name Description
value int

The enum numeric value on the wire for importance to set.
Returns
Type Description
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
Name Description
index int
value LogEntry
Returns
Type Description
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
Name Description
index int
builderForValue LogEntry.Builder
Returns
Type Description
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
Name Description
index int
value MetricValueSet
Returns
Type Description
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
Name Description
index int
builderForValue MetricValueSet.Builder
Returns
Type Description
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
Name Description
value String

The operationId to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for operationId to set.
Returns
Type Description
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
Name Description
value String

The operationName to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for operationName to set.
Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
Operation.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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