close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a project owned by the caller.

Args:
parent: string, Required. The location to create the project in. Only `global` is supported. Format: `projects/{project}/locations/global`. (required)
body: object, The request body.
The object takes the form of:

{ # A shared workspace for a user's related tasks . A CollaborativeProject is a top-level resource. Only the user who created it can read or change it.
"createTime": "A String", # Output only. The time the project was created.
"displayName": "A String", # Required. The user-visible name of the project. At most 256 characters.
"emoji": "A String", # Optional. The emoji shown as the project's icon.
"folder": "A String", # Optional. The full path of the local folder that backs the project, for a project created in the desktop app. Empty for a project created anywhere else.
"name": "A String", # Identifier. The resource name of the project. The service assigns the final ID segment. Format: `projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}`.
"trustedParticipants": [ # Optional. Unordered list. The participants granted access to the project. Each `(participant_type, identifier)` pair can appear at most once.
{ # A participant granted access to a CollaborativeProject.
"identifier": "A String", # Required. The participant's identity. For `AGENT`, the agent's SPIFFE ID without the `principal://` prefix, the same value as the agent's `effective_identity`.
"participantType": "A String", # Required. The type of the participant.
},
],
"updateTime": "A String", # Output only. The time the project was last updated.
}

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, successful response of the operation. 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.
},
}

delete(name, x__xgafv=None)

Deletes a project.

Args:
name: string, Required. The name of the project to delete. (required)
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, successful response of the operation. 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.
},
}

get(name, x__xgafv=None)

Gets a project.

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

Returns:
  An object of the form:

    { # A shared workspace for a user's related tasks . A CollaborativeProject is a top-level resource. Only the user who created it can read or change it.
  "createTime": "A String", # Output only. The time the project was created.
  "displayName": "A String", # Required. The user-visible name of the project. At most 256 characters.
  "emoji": "A String", # Optional. The emoji shown as the project's icon.
  "folder": "A String", # Optional. The full path of the local folder that backs the project, for a project created in the desktop app. Empty for a project created anywhere else.
  "name": "A String", # Identifier. The resource name of the project. The service assigns the final ID segment. Format: `projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}`.
  "trustedParticipants": [ # Optional. Unordered list. The participants granted access to the project. Each `(participant_type, identifier)` pair can appear at most once.
    { # A participant granted access to a CollaborativeProject.
      "identifier": "A String", # Required. The participant's identity. For `AGENT`, the agent's SPIFFE ID without the `principal://` prefix, the same value as the agent's `effective_identity`.
      "participantType": "A String", # Required. The type of the participant.
    },
  ],
  "updateTime": "A String", # Output only. The time the project was last updated.
}

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

Lists the caller's projects in a location, most recently created first.

Args:
  parent: string, Required. The location to list projects from. Format: `projects/{project}/locations/global`. (required)
  pageSize: integer, Optional. The maximum number of projects to return. The maximum is 100; larger values are coerced to 100. If not set, the default is 50.
  pageToken: string, Optional. A page token from a previous call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for CollaborativeProjectService.ListCollaborativeProjects.
  "collaborativeProjects": [ # The caller's projects, most recently created first.
    { # A shared workspace for a user's related tasks . A CollaborativeProject is a top-level resource. Only the user who created it can read or change it.
      "createTime": "A String", # Output only. The time the project was created.
      "displayName": "A String", # Required. The user-visible name of the project. At most 256 characters.
      "emoji": "A String", # Optional. The emoji shown as the project's icon.
      "folder": "A String", # Optional. The full path of the local folder that backs the project, for a project created in the desktop app. Empty for a project created anywhere else.
      "name": "A String", # Identifier. The resource name of the project. The service assigns the final ID segment. Format: `projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}`.
      "trustedParticipants": [ # Optional. Unordered list. The participants granted access to the project. Each `(participant_type, identifier)` pair can appear at most once.
        { # A participant granted access to a CollaborativeProject.
          "identifier": "A String", # Required. The participant's identity. For `AGENT`, the agent's SPIFFE ID without the `principal://` prefix, the same value as the agent's `effective_identity`.
          "participantType": "A String", # Required. The type of the participant.
        },
      ],
      "updateTime": "A String", # Output only. The time the project was last updated.
    },
  ],
  "nextPageToken": "A String", # A token for the next page. Empty if there are no more pages.
}

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.

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

Updates a project's display name or trusted participants.

Args:
  name: string, Identifier. The resource name of the project. The service assigns the final ID segment. Format: `projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A shared workspace for a user's related tasks . A CollaborativeProject is a top-level resource. Only the user who created it can read or change it.
  "createTime": "A String", # Output only. The time the project was created.
  "displayName": "A String", # Required. The user-visible name of the project. At most 256 characters.
  "emoji": "A String", # Optional. The emoji shown as the project's icon.
  "folder": "A String", # Optional. The full path of the local folder that backs the project, for a project created in the desktop app. Empty for a project created anywhere else.
  "name": "A String", # Identifier. The resource name of the project. The service assigns the final ID segment. Format: `projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}`.
  "trustedParticipants": [ # Optional. Unordered list. The participants granted access to the project. Each `(participant_type, identifier)` pair can appear at most once.
    { # A participant granted access to a CollaborativeProject.
      "identifier": "A String", # Required. The participant's identity. For `AGENT`, the agent's SPIFFE ID without the `principal://` prefix, the same value as the agent's `effective_identity`.
      "participantType": "A String", # Required. The type of the participant.
    },
  ],
  "updateTime": "A String", # Output only. The time the project was last updated.
}

  updateMask: string, Required. The fields to update: `display_name`, `trusted_participants`, or `*` for both.
  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, successful response of the operation. 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.
  },
}

Agent Platform API . projects . locations . collaborativeProjects

Instance Methods

Method Details