com.google.api.servicecontrol.v1

Interface OperationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Operation, Operation.Builder

public interface OperationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) Labels describing the operation.
java.lang.String	getConsumerId() Identity of the consumer who is using the service.
com.google.protobuf.ByteString	getConsumerIdBytes() Identity of the consumer who is using the service.
com.google.protobuf.Timestamp	getEndTime() End time of the operation.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() End time of the operation.
Operation.Importance	getImportance() DO NOT USE.
int	getImportanceValue() DO NOT USE.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() Labels describing the operation.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() Labels describing the operation.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) Labels describing the operation.
java.lang.String	getLabelsOrThrow(java.lang.String key) Labels describing the operation.
LogEntry	getLogEntries(int index) Represents information to be logged.
int	getLogEntriesCount() Represents information to be logged.
java.util.List<LogEntry>	getLogEntriesList() Represents information to be logged.
LogEntryOrBuilder	getLogEntriesOrBuilder(int index) Represents information to be logged.
java.util.List<? extends LogEntryOrBuilder>	getLogEntriesOrBuilderList() Represents information to be logged.
MetricValueSet	getMetricValueSets(int index) Represents information about this operation.
int	getMetricValueSetsCount() Represents information about this operation.
java.util.List<MetricValueSet>	getMetricValueSetsList() Represents information about this operation.
MetricValueSetOrBuilder	getMetricValueSetsOrBuilder(int index) Represents information about this operation.
java.util.List<? extends MetricValueSetOrBuilder>	getMetricValueSetsOrBuilderList() Represents information about this operation.
java.lang.String	getOperationId() Identity of the operation.
com.google.protobuf.ByteString	getOperationIdBytes() Identity of the operation.
java.lang.String	getOperationName() Fully qualified name of the operation.
com.google.protobuf.ByteString	getOperationNameBytes() Fully qualified name of the operation.
com.google.protobuf.Timestamp	getStartTime() Required.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Required.
boolean	hasEndTime() End time of the operation.
boolean	hasStartTime() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getOperationId

java.lang.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.
 

optional string operation_id = 1;

getOperationIdBytes

com.google.protobuf.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.
 

optional string operation_id = 1;

getOperationName

java.lang.String getOperationName()

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

optional string operation_name = 2;

getOperationNameBytes

com.google.protobuf.ByteString getOperationNameBytes()

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

optional string operation_name = 2;

getConsumerId

java.lang.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>,
   api_key:<api_key>.
 

optional string consumer_id = 3;

getConsumerIdBytes

com.google.protobuf.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>,
   api_key:<api_key>.
 

optional string consumer_id = 3;

hasStartTime

boolean hasStartTime()

 Required. Start time of the operation.
 

optional .google.protobuf.Timestamp start_time = 4;

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Required. Start time of the operation.
 

optional .google.protobuf.Timestamp start_time = 4;

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Required. Start time of the operation.
 

optional .google.protobuf.Timestamp start_time = 4;

hasEndTime

boolean hasEndTime()

 End time of the operation.
 Required when the operation is used in [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report],
 but optional when the operation is used in [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
 

optional .google.protobuf.Timestamp end_time = 5;

getEndTime

com.google.protobuf.Timestamp getEndTime()

 End time of the operation.
 Required when the operation is used in [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report],
 but optional when the operation is used in [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
 

optional .google.protobuf.Timestamp end_time = 5;

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 End time of the operation.
 Required when the operation is used in [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report],
 but optional when the operation is used in [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
 

optional .google.protobuf.Timestamp end_time = 5;

getLabelsCount

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 (e.g. GAE, GCE, GKE).
 

map<string, string> labels = 6;

containsLabels

boolean containsLabels(java.lang.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 (e.g. GAE, GCE, GKE).
 

map<string, string> labels = 6;

getLabels

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

java.util.Map<java.lang.String,java.lang.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 (e.g. GAE, GCE, GKE).
 

map<string, string> labels = 6;

getLabelsOrDefault

java.lang.String getLabelsOrDefault(java.lang.String key,
                                    java.lang.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 (e.g. GAE, GCE, GKE).
 

map<string, string> labels = 6;

getLabelsOrThrow

java.lang.String getLabelsOrThrow(java.lang.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 (e.g. GAE, GCE, GKE).
 

map<string, string> labels = 6;

getMetricValueSetsList

java.util.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;

getMetricValueSets

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;

getMetricValueSetsCount

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;

getMetricValueSetsOrBuilderList

java.util.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;

getMetricValueSetsOrBuilder

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;

getLogEntriesList

java.util.List<LogEntry> getLogEntriesList()

 Represents information to be logged.
 

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

getLogEntries

LogEntry getLogEntries(int index)

 Represents information to be logged.
 

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

getLogEntriesCount

int getLogEntriesCount()

 Represents information to be logged.
 

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

getLogEntriesOrBuilderList

java.util.List<? extends LogEntryOrBuilder> getLogEntriesOrBuilderList()

 Represents information to be logged.
 

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

getLogEntriesOrBuilder

LogEntryOrBuilder getLogEntriesOrBuilder(int index)

 Represents information to be logged.
 

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

getImportanceValue

int getImportanceValue()

 DO NOT USE. This is an experimental field.
 

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

getImportance

Operation.Importance getImportance()

 DO NOT USE. This is an experimental field.
 

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