- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.1.10
public interface OperationOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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/locationdescribing the location where the operation happened,servicecontrol.googleapis.com/user_agentdescribing the user agent of the API request,servicecontrol.googleapis.com/service_agentdescribing the service used to handle the API request (e.g. ESP),servicecontrol.googleapis.com/platformdescribing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.
map<string, string> labels = 6;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getConsumerId()
public abstract 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;
| Type | Description |
| String | The consumerId. |
getConsumerIdBytes()
public abstract 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;
| Type | Description |
| ByteString | The bytes for consumerId. |
getEndTime()
public abstract 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;
| Type | Description |
| Timestamp | The endTime. |
getEndTimeOrBuilder()
public abstract 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;
| Type | Description |
| TimestampOrBuilder |
getExtensions(int index)
public abstract Any getExtensions(int index)Unimplemented.
repeated .google.protobuf.Any extensions = 16;
| Name | Description |
| index | int |
| Type | Description |
| Any |
getExtensionsCount()
public abstract int getExtensionsCount()Unimplemented.
repeated .google.protobuf.Any extensions = 16;
| Type | Description |
| int |
getExtensionsList()
public abstract List<Any> getExtensionsList()Unimplemented.
repeated .google.protobuf.Any extensions = 16;
| Type | Description |
| List<Any> |
getExtensionsOrBuilder(int index)
public abstract AnyOrBuilder getExtensionsOrBuilder(int index)Unimplemented.
repeated .google.protobuf.Any extensions = 16;
| Name | Description |
| index | int |
| Type | Description |
| AnyOrBuilder |
getExtensionsOrBuilderList()
public abstract List<? extends AnyOrBuilder> getExtensionsOrBuilderList()Unimplemented.
repeated .google.protobuf.Any extensions = 16;
| Type | Description |
| List<? extends com.google.protobuf.AnyOrBuilder> |
getImportance()
public abstract Operation.Importance getImportance()DO NOT USE. This is an experimental field.
.google.api.servicecontrol.v1.Operation.Importance importance = 11;
| Type | Description |
| Operation.Importance | The importance. |
getImportanceValue()
public abstract int getImportanceValue()DO NOT USE. This is an experimental field.
.google.api.servicecontrol.v1.Operation.Importance importance = 11;
| Type | Description |
| int | The enum numeric value on the wire for importance. |
getLabels()
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Type | Description |
| Map<String,String> |
getLabelsCount()
public abstract 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/locationdescribing the location where the operation happened,servicecontrol.googleapis.com/user_agentdescribing the user agent of the API request,servicecontrol.googleapis.com/service_agentdescribing the service used to handle the API request (e.g. ESP),servicecontrol.googleapis.com/platformdescribing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.
map<string, string> labels = 6;
| Type | Description |
| int |
getLabelsMap()
public abstract 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/locationdescribing the location where the operation happened,servicecontrol.googleapis.com/user_agentdescribing the user agent of the API request,servicecontrol.googleapis.com/service_agentdescribing the service used to handle the API request (e.g. ESP),servicecontrol.googleapis.com/platformdescribing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.
map<string, string> labels = 6;
| Type | Description |
| Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public abstract 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/locationdescribing the location where the operation happened,servicecontrol.googleapis.com/user_agentdescribing the user agent of the API request,servicecontrol.googleapis.com/service_agentdescribing the service used to handle the API request (e.g. ESP),servicecontrol.googleapis.com/platformdescribing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.
map<string, string> labels = 6;
| Name | Description |
| key | String |
| defaultValue | String |
| Type | Description |
| String |
getLabelsOrThrow(String key)
public abstract 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/locationdescribing the location where the operation happened,servicecontrol.googleapis.com/user_agentdescribing the user agent of the API request,servicecontrol.googleapis.com/service_agentdescribing the service used to handle the API request (e.g. ESP),servicecontrol.googleapis.com/platformdescribing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.
map<string, string> labels = 6;
| Name | Description |
| key | String |
| Type | Description |
| String |
getLogEntries(int index)
public abstract LogEntry getLogEntries(int index)Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
| Name | Description |
| index | int |
| Type | Description |
| LogEntry |
getLogEntriesCount()
public abstract int getLogEntriesCount()Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
| Type | Description |
| int |
getLogEntriesList()
public abstract List<LogEntry> getLogEntriesList()Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
| Type | Description |
| List<LogEntry> |
getLogEntriesOrBuilder(int index)
public abstract LogEntryOrBuilder getLogEntriesOrBuilder(int index)Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
| Name | Description |
| index | int |
| Type | Description |
| LogEntryOrBuilder |
getLogEntriesOrBuilderList()
public abstract List<? extends LogEntryOrBuilder> getLogEntriesOrBuilderList()Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
| Type | Description |
| List<? extends com.google.api.servicecontrol.v1.LogEntryOrBuilder> |
getMetricValueSets(int index)
public abstract 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;
| Name | Description |
| index | int |
| Type | Description |
| MetricValueSet |
getMetricValueSetsCount()
public abstract 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;
| Type | Description |
| int |
getMetricValueSetsList()
public abstract 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;
| Type | Description |
| List<MetricValueSet> |
getMetricValueSetsOrBuilder(int index)
public abstract 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;
| Name | Description |
| index | int |
| Type | Description |
| MetricValueSetOrBuilder |
getMetricValueSetsOrBuilderList()
public abstract 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;
| Type | Description |
| List<? extends com.google.api.servicecontrol.v1.MetricValueSetOrBuilder> |
getOperationId()
public abstract 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;
| Type | Description |
| String | The operationId. |
getOperationIdBytes()
public abstract 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;
| Type | Description |
| ByteString | The bytes for operationId. |
getOperationName()
public abstract String getOperationName()Fully qualified name of the operation. Reserved for future use.
string operation_name = 2;
| Type | Description |
| String | The operationName. |
getOperationNameBytes()
public abstract ByteString getOperationNameBytes()Fully qualified name of the operation. Reserved for future use.
string operation_name = 2;
| Type | Description |
| ByteString | The bytes for operationName. |
getStartTime()
public abstract Timestamp getStartTime()Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;
| Type | Description |
| Timestamp | The startTime. |
getStartTimeOrBuilder()
public abstract TimestampOrBuilder getStartTimeOrBuilder()Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;
| Type | Description |
| TimestampOrBuilder |
hasEndTime()
public abstract 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;
| Type | Description |
| boolean | Whether the endTime field is set. |
hasStartTime()
public abstract boolean hasStartTime()Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;
| Type | Description |
| boolean | Whether the startTime field is set. |