Network Connectivity API . projects . locations . serviceConnectionTokens

Instance Methods

close()

Close httplib2 connections.

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

Creates a new ServiceConnectionToken in a given project and location.

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

Deletes a single ServiceConnectionToken.

get(name, x__xgafv=None)

Gets details of a single ServiceConnectionToken.

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

Lists ServiceConnectionTokens in a given project and location.

list_next()

Retrieves the next page of results.

Method Details

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

Args:
  parent: string, Required. The parent resource's name of the ServiceConnectionToken. ex. projects/123/locations/us-east1 (required)
  body: object, The request body.
    The object takes the form of:

{ # The ServiceConnectionToken resource. Next id: 10
  "createTime": "A String", # Output only. Time when the ServiceConnectionToken was created.
  "description": "A String", # A description of this resource.
  "etag": "A String", # Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "expireTime": "A String", # Output only. The time to which this token is valid.
  "labels": { # User-defined labels.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. The name of a ServiceConnectionToken. Format: projects/{project}/locations/{location}/ServiceConnectionTokens/{service_connection_token} See: https://google.aip.dev/122#fields-representing-resource-names
  "network": "A String", # The resource path of the network associated with this token. Example: projects/{projectNumOrId}/global/networks/{resourceId}.
  "token": "A String", # Output only. The token generated by Automation.
  "updateTime": "A String", # Output only. Time when the ServiceConnectionToken was updated.
}

  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  serviceConnectionTokenId: string, Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/ServiceConnectionTokens/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated.
  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 ServiceConnectionToken.

Args:
  name: string, Required. The name of the ServiceConnectionToken to delete. (required)
  etag: string, Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  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 ServiceConnectionToken.

Args:
  name: string, Required. Name of the ServiceConnectionToken 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:

    { # The ServiceConnectionToken resource. Next id: 10
  "createTime": "A String", # Output only. Time when the ServiceConnectionToken was created.
  "description": "A String", # A description of this resource.
  "etag": "A String", # Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "expireTime": "A String", # Output only. The time to which this token is valid.
  "labels": { # User-defined labels.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. The name of a ServiceConnectionToken. Format: projects/{project}/locations/{location}/ServiceConnectionTokens/{service_connection_token} See: https://google.aip.dev/122#fields-representing-resource-names
  "network": "A String", # The resource path of the network associated with this token. Example: projects/{projectNumOrId}/global/networks/{resourceId}.
  "token": "A String", # Output only. The token generated by Automation.
  "updateTime": "A String", # Output only. Time when the ServiceConnectionToken was updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceConnectionTokens in a given project and location.

Args:
  parent: string, Required. The parent resource's name. ex. projects/123/locations/us-east1 (required)
  filter: string, A filter expression that filters the results listed in the response.
  orderBy: string, Sort the results by a certain order.
  pageSize: integer, The maximum number of results per page that should be returned.
  pageToken: string, The page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListServiceConnectionTokens.
  "nextPageToken": "A String", # The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.
  "serviceConnectionTokens": [ # ServiceConnectionTokens to be returned.
    { # The ServiceConnectionToken resource. Next id: 10
      "createTime": "A String", # Output only. Time when the ServiceConnectionToken was created.
      "description": "A String", # A description of this resource.
      "etag": "A String", # Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
      "expireTime": "A String", # Output only. The time to which this token is valid.
      "labels": { # User-defined labels.
        "a_key": "A String",
      },
      "name": "A String", # Immutable. The name of a ServiceConnectionToken. Format: projects/{project}/locations/{location}/ServiceConnectionTokens/{service_connection_token} See: https://google.aip.dev/122#fields-representing-resource-names
      "network": "A String", # The resource path of the network associated with this token. Example: projects/{projectNumOrId}/global/networks/{resourceId}.
      "token": "A String", # Output only. The token generated by Automation.
      "updateTime": "A String", # Output only. Time when the ServiceConnectionToken was updated.
    },
  ],
  "unreachable": [ # 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.