# Network Security API . projects . locations . sacRealms

## Instance Methods

Close httplib2 connections.

Creates a new SACRealm in a given project.

Deletes the specified realm.

Returns the specified realm.

Lists SACRealms in a given project.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, requestId=None, sacRealmId=None, x__xgafv=None)`

    Creates a new SACRealm in a given project.

    Args:
      parent: string, Required. The parent, in the form `projects/{project}/locations/global`. (required)
      body: object, The request body.
        The object takes the form of:

    { # Represents a Secure Access Connect (SAC) realm resource. A Secure Access Connect realm establishes a connection between your Google Cloud project and an SSE service.
      "createTime": "A String", # Output only. Timestamp when the realm was created.
      "labels": { # Optional. Optional list of labels applied to the resource.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.
      "pairingKey": { # Key to be shared with SSE service provider to establish global handshake. # Output only. Key to be shared with SSE service provider during pairing.
        "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired. It expires 7 days after creation.
        "key": "A String", # Output only. Key value.
      },
      "securityService": "A String", # Immutable. SSE service provider associated with the realm.
      "state": "A String", # Output only. State of the realm.
      "updateTime": "A String", # Output only. Timestamp when the realm was last 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).
      sacRealmId: string, Required. ID of the created realm. The ID must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      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, requestId=None, x__xgafv=None)`

    Deletes the specified realm.

    Args:
      name: string, Required. Name of the resource, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`. (required)
      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)`

    Returns the specified realm.

    Args:
      name: string, Required. Name of the resource, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`. (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 Secure Access Connect (SAC) realm resource. A Secure Access Connect realm establishes a connection between your Google Cloud project and an SSE service.
      "createTime": "A String", # Output only. Timestamp when the realm was created.
      "labels": { # Optional. Optional list of labels applied to the resource.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.
      "pairingKey": { # Key to be shared with SSE service provider to establish global handshake. # Output only. Key to be shared with SSE service provider during pairing.
        "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired. It expires 7 days after creation.
        "key": "A String", # Output only. Key value.
      },
      "securityService": "A String", # Immutable. SSE service provider associated with the realm.
      "state": "A String", # Output only. State of the realm.
      "updateTime": "A String", # Output only. Timestamp when the realm was last updated.
    }

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

    Lists SACRealms in a given project.

    Args:
      parent: string, Required. The parent, in the form `projects/{project}/locations/global`. (required)
      filter: string, Optional. An expression that filters the list of results.
      orderBy: string, Optional. Sort the results by a certain order.
      pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
      pageToken: string, Optional. A token identifying a page of results the server should return.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response for `ListSACRealms` method.
      "nextPageToken": "A String", # A token identifying a page of results the server should return.
      "sacRealms": [ # The list of SACRealms.
        { # Represents a Secure Access Connect (SAC) realm resource. A Secure Access Connect realm establishes a connection between your Google Cloud project and an SSE service.
          "createTime": "A String", # Output only. Timestamp when the realm was created.
          "labels": { # Optional. Optional list of labels applied to the resource.
            "a_key": "A String",
          },
          "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.
          "pairingKey": { # Key to be shared with SSE service provider to establish global handshake. # Output only. Key to be shared with SSE service provider during pairing.
            "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired. It expires 7 days after creation.
            "key": "A String", # Output only. Key value.
          },
          "securityService": "A String", # Immutable. SSE service provider associated with the realm.
          "state": "A String", # Output only. State of the realm.
          "updateTime": "A String", # Output only. Timestamp when the realm was last 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.