Container Analysis API . projects . operations

Instance Methods

create(parent, body, x__xgafv=None)

Creates a new `Operation`.

patch(name, body, x__xgafv=None)

Updates an existing operation returns an error if operation

Method Details

create(parent, body, x__xgafv=None)
Creates a new `Operation`.

Args:
  parent: string, The project Id that this operation should be created under. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for creating an operation
    "operation": { # This resource represents a long-running operation that is the result of a # The operation to create.
        # network API call.
      "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
          # different programming environments, including REST APIs and RPC APIs. It is
          # used by [gRPC](https://github.com/grpc). Each `Status` message contains
          # three pieces of data: error code, error message, and error details.
          #
          # You can find out more about this error model and how to work with it in the
          # [API Design Guide](https://cloud.google.com/apis/design/errors).
        "message": "A String", # A developer-facing error message, which should be in English. Any
            # user-facing error message should be localized and sent in the
            # google.rpc.Status.details field, or localized by the client.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details.  There is a common set of
            # message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
      },
      "done": True or False, # If the value is `false`, it means the operation is still in progress.
          # If `true`, the operation is completed, and either `error` or `response` is
          # available.
      "response": { # The normal response of the operation in case of success.  If the original
          # method returns no data on success, such as `Delete`, the response is
          # `google.protobuf.Empty`.  If the original method is standard
          # `Get`/`Create`/`Update`, the response should be the resource.  For other
          # methods, the response should have the type `XxxResponse`, where `Xxx`
          # is the original method name.  For example, if the original method name
          # is `TakeSnapshot()`, the inferred response type is
          # `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that
          # originally returns it. If you use the default HTTP mapping, the
          # `name` should be a resource name ending with `operations/{unique_id}`.
      "metadata": { # Service-specific metadata associated with the operation.  It typically
          # contains progress information and common metadata such as create time.
          # Some services might not provide such metadata.  Any method that returns a
          # long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    },
    "operationId": "A String", # The ID to use for this operation.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
patch(name, body, x__xgafv=None)
Updates an existing operation returns an error if operation
 does not exist. The only valid operations are to update mark the done bit
change the result.

Args:
  name: string, The name of the Operation.
Should be of the form "projects/{provider_id}/operations/{operation_id}". (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for updating an existing operation
    "operation": { # This resource represents a long-running operation that is the result of a # The operation to create.
        # network API call.
      "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
          # different programming environments, including REST APIs and RPC APIs. It is
          # used by [gRPC](https://github.com/grpc). Each `Status` message contains
          # three pieces of data: error code, error message, and error details.
          #
          # You can find out more about this error model and how to work with it in the
          # [API Design Guide](https://cloud.google.com/apis/design/errors).
        "message": "A String", # A developer-facing error message, which should be in English. Any
            # user-facing error message should be localized and sent in the
            # google.rpc.Status.details field, or localized by the client.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details.  There is a common set of
            # message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
      },
      "done": True or False, # If the value is `false`, it means the operation is still in progress.
          # If `true`, the operation is completed, and either `error` or `response` is
          # available.
      "response": { # The normal response of the operation in case of success.  If the original
          # method returns no data on success, such as `Delete`, the response is
          # `google.protobuf.Empty`.  If the original method is standard
          # `Get`/`Create`/`Update`, the response should be the resource.  For other
          # methods, the response should have the type `XxxResponse`, where `Xxx`
          # is the original method name.  For example, if the original method name
          # is `TakeSnapshot()`, the inferred response type is
          # `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that
          # originally returns it. If you use the default HTTP mapping, the
          # `name` should be a resource name ending with `operations/{unique_id}`.
      "metadata": { # Service-specific metadata associated with the operation.  It typically
          # contains progress information and common metadata such as create time.
          # Some services might not provide such metadata.  Any method that returns a
          # long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    },
    "updateMask": "A String", # The fields to update.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }