Network Connectivity API . projects . locations . pscAuthorizationPolicies

Instance Methods

close()

Close httplib2 connections.

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

Creates a new PscAuthorizationPolicy in a given project and location.

delete(name, etag=None, requestId=None, x__xgafv=None)

Deletes a single PscAuthorizationPolicy.

get(name, x__xgafv=None)

Gets details of a single PscAuthorizationPolicy.

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

Lists PscAuthorizationPolicies in a given project and location.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, pscAuthorizationPolicyId=None, requestId=None, x__xgafv=None)
Creates a new PscAuthorizationPolicy in a given project and location.

Args:
  parent: string, Required. The parent resource's name of the PscAuthorizationPolicy. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a PSC Authorization Policy.
  "authorizationMode": "A String", # Required. The authorization mode.
  "authorizedClientResources": [ # Required. List of authorized consumer resources allowed to connect. Supported values are: 1. Project resource name (e.g., `projects/{project_id}`) 2. Wildcard `"*"` (grants global ingress authorization to the target).
    "A String",
  ],
  "createTime": "A String", # Output only. The time when the PscAuthorizationPolicy was created.
  "description": "A String", # Optional. A description of this resource.
  "etag": "A String", # Output only. The etag of the PscAuthorizationPolicy.
  "labels": { # Optional. User-defined labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The name of the PscAuthorizationPolicy. Format: projects/{project}/locations/{location}/pscAuthorizationPolicies/{psc_authorization_policy}
  "targetResourceUri": "A String", # Required. The full absolute URI of the targeted resource governed by this policy. For example, for an AgentRegistry resource, the format is: `//agentregistry.googleapis.com/projects/{project}/locations/{location}`
  "uid": "A String", # Output only. The unique identifier of the PscAuthorizationPolicy.
  "updateTime": "A String", # Output only. The time when the PscAuthorizationPolicy was updated.
}

  pscAuthorizationPolicyId: string, Required. Resource ID of the PscAuthorizationPolicy.
  requestId: string, Optional. An optional request ID to identify requests.
  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, etag=None, requestId=None, x__xgafv=None)
Deletes a single PscAuthorizationPolicy.

Args:
  name: string, Required. The name of the PscAuthorizationPolicy to delete. (required)
  etag: string, Optional. The etag of the PscAuthorizationPolicy to delete.
  requestId: string, Optional. An optional request ID to identify requests.
  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 details of a single PscAuthorizationPolicy.

Args:
  name: string, Required. Name of the PscAuthorizationPolicy to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a PSC Authorization Policy.
  "authorizationMode": "A String", # Required. The authorization mode.
  "authorizedClientResources": [ # Required. List of authorized consumer resources allowed to connect. Supported values are: 1. Project resource name (e.g., `projects/{project_id}`) 2. Wildcard `"*"` (grants global ingress authorization to the target).
    "A String",
  ],
  "createTime": "A String", # Output only. The time when the PscAuthorizationPolicy was created.
  "description": "A String", # Optional. A description of this resource.
  "etag": "A String", # Output only. The etag of the PscAuthorizationPolicy.
  "labels": { # Optional. User-defined labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The name of the PscAuthorizationPolicy. Format: projects/{project}/locations/{location}/pscAuthorizationPolicies/{psc_authorization_policy}
  "targetResourceUri": "A String", # Required. The full absolute URI of the targeted resource governed by this policy. For example, for an AgentRegistry resource, the format is: `//agentregistry.googleapis.com/projects/{project}/locations/{location}`
  "uid": "A String", # Output only. The unique identifier of the PscAuthorizationPolicy.
  "updateTime": "A String", # Output only. The time when the PscAuthorizationPolicy was updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists PscAuthorizationPolicies in a given project and location.

Args:
  parent: string, Required. The parent resource's name. (required)
  filter: string, Optional. Filter expression to restrict the results.
  orderBy: string, Optional. Sort order of the results.
  pageSize: integer, Optional. The maximum number of PscAuthorizationPolicies to return in a single page. The service may return fewer than this value. If unspecified, at most 50 PscAuthorizationPolicies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListPscAuthorizationPolicies` call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListPscAuthorizationPolicies.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page.
  "pscAuthorizationPolicies": [ # The list of PscAuthorizationPolicies.
    { # Represents a PSC Authorization Policy.
      "authorizationMode": "A String", # Required. The authorization mode.
      "authorizedClientResources": [ # Required. List of authorized consumer resources allowed to connect. Supported values are: 1. Project resource name (e.g., `projects/{project_id}`) 2. Wildcard `"*"` (grants global ingress authorization to the target).
        "A String",
      ],
      "createTime": "A String", # Output only. The time when the PscAuthorizationPolicy was created.
      "description": "A String", # Optional. A description of this resource.
      "etag": "A String", # Output only. The etag of the PscAuthorizationPolicy.
      "labels": { # Optional. User-defined labels.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The name of the PscAuthorizationPolicy. Format: projects/{project}/locations/{location}/pscAuthorizationPolicies/{psc_authorization_policy}
      "targetResourceUri": "A String", # Required. The full absolute URI of the targeted resource governed by this policy. For example, for an AgentRegistry resource, the format is: `//agentregistry.googleapis.com/projects/{project}/locations/{location}`
      "uid": "A String", # Output only. The unique identifier of the PscAuthorizationPolicy.
      "updateTime": "A String", # Output only. The time when the PscAuthorizationPolicy was updated.
    },
  ],
  "unreachable": [ # Unordered list. Locations that could not be reached.
    "A String",
  ],
}
list_next()
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.