Package com.google.cloud.functions.v2alpha

Interface OperationMetadataOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    OperationMetadata, OperationMetadata.Builder
    public interface OperationMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getApiVersion()
      API version used to start the operation.
      com.google.protobuf.ByteString getApiVersionBytes()
      API version used to start the operation.
      boolean getCancelRequested()
      Identifies whether the user has requested cancellation of the operation.
      com.google.protobuf.Timestamp getCreateTime()
      The time the operation was created.
      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
      The time the operation was created.
      com.google.protobuf.Timestamp getEndTime()
      The time the operation finished running.
      com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
      The time the operation finished running.
      com.google.protobuf.Any getRequestResource()
      The original request that started the operation.
      com.google.protobuf.AnyOrBuilder getRequestResourceOrBuilder()
      The original request that started the operation.
      Stage getStages​(int index)
      Mechanism for reporting in-progress stages
      int getStagesCount()
      Mechanism for reporting in-progress stages
      List<Stage> getStagesList()
      Mechanism for reporting in-progress stages
      StageOrBuilder getStagesOrBuilder​(int index)
      Mechanism for reporting in-progress stages
      List<? extends StageOrBuilder> getStagesOrBuilderList()
      Mechanism for reporting in-progress stages
      String getStatusDetail()
      Human-readable status of the operation, if any.
      com.google.protobuf.ByteString getStatusDetailBytes()
      Human-readable status of the operation, if any.
      String getTarget()
      Server-defined resource path for the target of the operation.
      com.google.protobuf.ByteString getTargetBytes()
      Server-defined resource path for the target of the operation.
      String getVerb()
      Name of the verb executed by the operation.
      com.google.protobuf.ByteString getVerbBytes()
      Name of the verb executed by the operation.
      boolean hasCreateTime()
      The time the operation was created.
      boolean hasEndTime()
      The time the operation finished running.
      boolean hasRequestResource()
      The original request that started the operation.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasCreateTime

        boolean hasCreateTime()
         The time the operation was created.
        .google.protobuf.Timestamp create_time = 1;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         The time the operation was created.
        .google.protobuf.Timestamp create_time = 1;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The time the operation was created.
        .google.protobuf.Timestamp create_time = 1;

      • hasEndTime

        boolean hasEndTime()
         The time the operation finished running.
        .google.protobuf.Timestamp end_time = 2;
        Returns:
        Whether the endTime field is set.

      • getEndTime

        com.google.protobuf.Timestamp getEndTime()
         The time the operation finished running.
        .google.protobuf.Timestamp end_time = 2;
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         The time the operation finished running.
        .google.protobuf.Timestamp end_time = 2;

      • getTarget

        String getTarget()
         Server-defined resource path for the target of the operation.
        string target = 3;
        Returns:
        The target.

      • getTargetBytes

        com.google.protobuf.ByteString getTargetBytes()
         Server-defined resource path for the target of the operation.
        string target = 3;
        Returns:
        The bytes for target.

      • getVerb

        String getVerb()
         Name of the verb executed by the operation.
        string verb = 4;
        Returns:
        The verb.

      • getVerbBytes

        com.google.protobuf.ByteString getVerbBytes()
         Name of the verb executed by the operation.
        string verb = 4;
        Returns:
        The bytes for verb.

      • getStatusDetail

        String getStatusDetail()
         Human-readable status of the operation, if any.
        string status_detail = 5;
        Returns:
        The statusDetail.

      • getStatusDetailBytes

        com.google.protobuf.ByteString getStatusDetailBytes()
         Human-readable status of the operation, if any.
        string status_detail = 5;
        Returns:
        The bytes for statusDetail.

      • getCancelRequested

        boolean getCancelRequested()
         Identifies whether the user has requested cancellation
 of the operation. Operations that have successfully been cancelled
 have [Operation.error][] value with a
 [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
 `Code.CANCELLED`.
        bool cancel_requested = 6;
        Returns:
        The cancelRequested.

      • getApiVersion

        String getApiVersion()
         API version used to start the operation.
        string api_version = 7;
        Returns:
        The apiVersion.

      • getApiVersionBytes

        com.google.protobuf.ByteString getApiVersionBytes()
         API version used to start the operation.
        string api_version = 7;
        Returns:
        The bytes for apiVersion.

      • hasRequestResource

        boolean hasRequestResource()
         The original request that started the operation.
        .google.protobuf.Any request_resource = 8;
        Returns:
        Whether the requestResource field is set.

      • getRequestResource

        com.google.protobuf.Any getRequestResource()
         The original request that started the operation.
        .google.protobuf.Any request_resource = 8;
        Returns:
        The requestResource.

      • getRequestResourceOrBuilder

        com.google.protobuf.AnyOrBuilder getRequestResourceOrBuilder()
         The original request that started the operation.
        .google.protobuf.Any request_resource = 8;

      • getStagesList

        List<Stage> getStagesList()
         Mechanism for reporting in-progress stages
        repeated .google.cloud.functions.v2alpha.Stage stages = 9;

      • getStages

        Stage getStages​(int index)
         Mechanism for reporting in-progress stages
        repeated .google.cloud.functions.v2alpha.Stage stages = 9;

      • getStagesCount

        int getStagesCount()
         Mechanism for reporting in-progress stages
        repeated .google.cloud.functions.v2alpha.Stage stages = 9;

      • getStagesOrBuilderList

        List<? extends StageOrBuilder> getStagesOrBuilderList()
         Mechanism for reporting in-progress stages
        repeated .google.cloud.functions.v2alpha.Stage stages = 9;

      • getStagesOrBuilder

        StageOrBuilder getStagesOrBuilder​(int index)
         Mechanism for reporting in-progress stages
        repeated .google.cloud.functions.v2alpha.Stage stages = 9;