delete(name, x__xgafv=None)

Deletes a deployment.

Args:
  name: string, Required. The name of the deployment. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}

get(name, x__xgafv=None)

Returns a requested deployment.

Args:
  name: string, Required. The name of the deployment. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Deployment.
  "allowedBillingModes": [ # The allowed billing modes under this deployment.
    "A String",
  ],
  "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
  "displayName": "A String", # The deployment's display name.
  "frns": [ # Output only. The FRNs copied from its direct parent.
    "A String",
  ],
  "name": "A String", # Output only. Resource name.
  "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.
    "A String",
  ],
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists deployments.

Args:
  parent: string, Required. The parent resource name, for example, "nodes/1", customer/1/nodes/2. (required)
  filter: string, The filter expression. The filter should have the following format: "DIRECT_CHILDREN" or format: "direct_children". The filter is case insensitive. If empty, then no deployments are filtered.
  pageSize: integer, The maximum number of deployments to return in the response.
  pageToken: string, A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListDeployments.
  "deployments": [ # The deployments that match the request.
    { # The Deployment.
      "allowedBillingModes": [ # The allowed billing modes under this deployment.
        "A String",
      ],
      "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
      "displayName": "A String", # The deployment's display name.
      "frns": [ # Output only. The FRNs copied from its direct parent.
        "A String",
      ],
      "name": "A String", # Output only. Resource name.
      "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.
        "A String",
      ],
    },
  ],
  "nextPageToken": "A String", # A pagination token returned from a previous call to ListDeployments that indicates from where listing should continue. If the field is missing or empty, it means there are no more deployments.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

move(name, body=None, x__xgafv=None)

Moves a deployment under another node or customer.

Args:
name: string, Required. The name of the deployment to move. (required)
body: object, The request body.
The object takes the form of:

{ # Request for MoveDeployment.
"destination": "A String", # Required. The name of the new parent resource node or customer to reparent the deployment under.
}

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.
"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.
"error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
"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.
},
],
"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.
},
"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.
},
"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}`.
"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.
},
}

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an existing deployment.

Args:
  name: string, Output only. Resource name. (required)
  body: object, The request body.
    The object takes the form of:

{ # The Deployment.
  "allowedBillingModes": [ # The allowed billing modes under this deployment.
    "A String",
  ],
  "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
  "displayName": "A String", # The deployment's display name.
  "frns": [ # Output only. The FRNs copied from its direct parent.
    "A String",
  ],
  "name": "A String", # Output only. Resource name.
  "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.
    "A String",
  ],
}

  updateMask: string, Fields to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The Deployment.
  "allowedBillingModes": [ # The allowed billing modes under this deployment.
    "A String",
  ],
  "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it.
  "displayName": "A String", # The deployment's display name.
  "frns": [ # Output only. The FRNs copied from its direct parent.
    "A String",
  ],
  "name": "A String", # Output only. Resource name.
  "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.
    "A String",
  ],
}

SAS Portal API . nodes . deployments

Instance Methods

Method Details