{ "revision": "20261013", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/sasportal": { "description": "Read, create, update, and delete your SAS Portal data." }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "basePath": "", "title": "SAS Portal API", "schemas": { "SasPortalValidateInstallerResponse": { "type": "object", "id": "SasPortalValidateInstallerResponse", "description": "Response for ValidateInstaller.", "properties": {} }, "SasPortalFrequencyRange": { "type": "object", "description": "Frequency range from `low_frequency` to `high_frequency`.", "id": "SasPortalFrequencyRange", "properties": { "lowFrequencyMhz": { "format": "double", "description": "The lowest frequency of the frequency range in MHz.", "type": "number" }, "highFrequencyMhz": { "description": "The highest frequency of the frequency range in MHz.", "type": "number", "format": "double" } } }, "SasPortalPolicy": { "id": "SasPortalPolicy", "type": "object", "properties": { "assignments": { "description": "List of assignments", "items": { "$ref": "SasPortalAssignment" }, "type": "array" }, "etag": { "format": "byte", "type": "string", "description": "The etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to GetPolicy, and systems are expected to put that etag in the request to SetPolicy to ensure that their change will be applied to the same version of the policy. If no etag is provided in the call to GetPolicy, then the existing policy is overwritten blindly." } }, "description": "Defines an access control policy to the resources." }, "SasPortalCreateSignedDeviceRequest": { "type": "object", "description": "Request for CreateSignedDevice.", "id": "SasPortalCreateSignedDeviceRequest", "properties": { "installerId": { "description": "Required. Unique installer id (CPI ID) from the Certified Professional Installers database.", "type": "string" }, "encodedDevice": { "description": "Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. The user_id field must be set.", "type": "string", "format": "byte" } } }, "SasPortalValidateInstallerRequest": { "type": "object", "id": "SasPortalValidateInstallerRequest", "properties": { "encodedSecret": { "type": "string", "description": "Required. JSON Web Token signed using a CPI private key. Payload must include a \"secret\" claim whose value is the secret." }, "secret": { "type": "string", "description": "Required. Secret returned by the GenerateSecret." }, "installerId": { "description": "Required. Unique installer id (CPI ID) from the Certified Professional Installers database.", "type": "string" } }, "description": "Request for ValidateInstaller." }, "SasPortalSignDeviceRequest": { "properties": { "device": { "description": "Required. The device to sign. The device fields name, fcc_id and serial_number must be set. The user_id field must be set.", "$ref": "SasPortalDevice" } }, "type": "object", "description": "Request for SignDevice.", "id": "SasPortalSignDeviceRequest" }, "SasPortalDpaMoveList": { "id": "SasPortalDpaMoveList", "description": "An entry in a DPA's move list.", "properties": { "frequencyRange": { "$ref": "SasPortalFrequencyRange", "description": "The frequency range that the move list affects." }, "dpaId": { "type": "string", "description": "The ID of the DPA." } }, "type": "object" }, "SasPortalListGcpProjectDeploymentsResponse": { "description": "Response for [ListGcpProjectDeployments].", "id": "SasPortalListGcpProjectDeploymentsResponse", "properties": { "deployments": { "description": "Optional. Deployments associated with the GCP project", "type": "array", "items": { "$ref": "SasPortalGcpProjectDeployment" } } }, "type": "object" }, "SasPortalTestPermissionsRequest": { "description": "Request message for `TestPermissions` method.", "properties": { "resource": { "type": "string", "description": "Required. The resource for which the permissions are being requested." }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The set of permissions to check for the `resource`." } }, "id": "SasPortalTestPermissionsRequest", "type": "object" }, "SasPortalNrqzValidation": { "description": "Information about National Radio Quiet Zone validation.", "properties": { "state": { "description": "State of the NRQZ validation info.", "enum": [ "STATE_UNSPECIFIED", "DRAFT", "FINAL" ], "enumDescriptions": [ "Unspecified state.", "Draft state.", "Final state." ], "type": "string" }, "longitude": { "type": "number", "description": "Device longitude that's associated with the validation.", "format": "double" }, "cpiId": { "description": "CPI who signed the validation.", "type": "string" }, "caseId": { "type": "string", "description": "Validation case ID." }, "latitude": { "description": "Device latitude that's associated with the validation.", "type": "number", "format": "double" } }, "type": "object", "id": "SasPortalNrqzValidation" }, "SasPortalGcpProjectDeployment": { "type": "object", "properties": { "hasEnabledAnalytics": { "type": "boolean", "description": "Whether SAS analytics has been enabled." }, "deployment": { "description": "Deployment associated with the GCP project.", "$ref": "SasPortalDeployment" } }, "description": "Deployment associated with the GCP project. Includes whether SAS analytics has been enabled or not.", "id": "SasPortalGcpProjectDeployment" }, "SasPortalMoveDeviceRequest": { "description": "Request for MoveDevice.", "properties": { "destination": { "description": "Required. The name of the new parent resource node or customer to reparent the device under.", "type": "string" } }, "id": "SasPortalMoveDeviceRequest", "type": "object" }, "SasPortalProvisionDeploymentResponse": { "id": "SasPortalProvisionDeploymentResponse", "type": "object", "properties": { "errorMessage": { "description": "Optional. Optional error message if the provisioning request is not successful.", "type": "string" } }, "description": "Response for [ProvisionDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]." }, "SasPortalUpdateSignedDeviceRequest": { "properties": { "encodedDevice": { "description": "Required. The JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. The user_id field must be set.", "format": "byte", "type": "string" }, "installerId": { "description": "Required. Unique installer ID (CPI ID) from the Certified Professional Installers database.", "type": "string" } }, "description": "Request for UpdateSignedDevice.", "id": "SasPortalUpdateSignedDeviceRequest", "type": "object" }, "SasPortalGenerateSecretResponse": { "id": "SasPortalGenerateSecretResponse", "description": "Response for GenerateSecret.", "type": "object", "properties": { "secret": { "type": "string", "description": "The secret generated by the string and used by ValidateInstaller." } } }, "SasPortalNode": { "description": "The Node.", "type": "object", "id": "SasPortalNode", "properties": { "sasUserIds": { "description": "User ids used by the devices belonging to this node.", "items": { "type": "string" }, "type": "array" }, "displayName": { "type": "string", "description": "The node's display name." }, "name": { "description": "Output only. Resource name.", "type": "string" } } }, "SasPortalAssignment": { "type": "object", "properties": { "role": { "description": "Required. Role that is assigned to `members`.", "type": "string" }, "members": { "type": "array", "description": "The identities the role is assigned to. It can have the following values: * `{user_email}`: An email address that represents a specific Google account. For example: `alice@gmail.com`. * `{group_email}`: An email address that represents a Google group. For example, `viewers@gmail.com`.", "items": { "type": "string" } } }, "id": "SasPortalAssignment", "description": "Associates `members` with a `role`." }, "SasPortalGetPolicyRequest": { "properties": { "resource": { "type": "string", "description": "Required. The resource for which the policy is being requested." } }, "description": "Request message for `GetPolicy` method.", "id": "SasPortalGetPolicyRequest", "type": "object" }, "SasPortalCustomer": { "description": "Entity representing a SAS customer.", "type": "object", "properties": { "displayName": { "description": "Required. Name of the organization that the customer entity represents.", "type": "string" }, "name": { "description": "Output only. Resource name of the customer.", "type": "string" }, "sasUserIds": { "type": "array", "description": "User IDs used by the devices belonging to this customer.", "items": { "type": "string" } } }, "id": "SasPortalCustomer" }, "SasPortalListDevicesResponse": { "description": "Response for ListDevices.", "type": "object", "id": "SasPortalListDevicesResponse", "properties": { "nextPageToken": { "description": "A pagination token returned from a previous call to ListDevices that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices.", "type": "string" }, "devices": { "items": { "$ref": "SasPortalDevice" }, "type": "array", "description": "The devices that match the request." } } }, "SasPortalMoveNodeRequest": { "description": "Request for MoveNode.", "properties": { "destination": { "type": "string", "description": "Required. The name of the new parent resource node or customer to reparent the node under." } }, "id": "SasPortalMoveNodeRequest", "type": "object" }, "SasPortalDeployment": { "type": "object", "id": "SasPortalDeployment", "properties": { "frns": { "description": "Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.", "type": "array", "readOnly": true, "items": { "type": "string" } }, "sasUserIds": { "type": "array", "description": "User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.", "items": { "type": "string" } }, "displayName": { "description": "The deployment's display name.", "type": "string" }, "name": { "description": "Output only. Resource name.", "type": "string", "readOnly": true } }, "description": "The Deployment." }, "SasPortalChannelWithScore": { "id": "SasPortalChannelWithScore", "type": "object", "properties": { "frequencyRange": { "$ref": "SasPortalFrequencyRange", "description": "The frequency range of the channel." }, "score": { "description": "The channel score, normalized to be in the range [0,100].", "format": "double", "type": "number" } }, "description": "The channel with score." }, "SasPortalDeviceMetadata": { "id": "SasPortalDeviceMetadata", "description": "Device data overridable by both SAS Portal and registration requests.", "type": "object", "properties": { "nrqzValidated": { "description": "Output only. Set to `true` if a CPI has validated that they have coordinated with the National Quiet Zone office.", "readOnly": true, "deprecated": true, "type": "boolean" }, "commonChannelGroup": { "description": "Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf).", "type": "string" }, "antennaModel": { "type": "string", "description": "If populated, the Antenna Model Pattern to use. Format is: `RecordCreatorId:PatternId`" }, "interferenceCoordinationGroup": { "type": "string", "description": "Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf)." }, "nrqzValidation": { "description": "Output only. National Radio Quiet Zone validation info.", "readOnly": true, "$ref": "SasPortalNrqzValidation" } } }, "SasPortalEmpty": { "properties": {}, "type": "object", "description": "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); }", "id": "SasPortalEmpty" }, "SasPortalMigrateOrganizationRequest": { "type": "object", "description": "Request for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP Project, Organization Info, and caller's GAIA ID should be retrieved from the RPC handler, and used to check authorization on SAS Portal organization and to create GCP Projects.", "id": "SasPortalMigrateOrganizationRequest", "properties": { "organizationId": { "description": "Required. Id of the SAS organization to be migrated.", "type": "string", "format": "int64" } } }, "SasPortalMigrateOrganizationResponse": { "type": "object", "properties": { "deploymentAssociation": { "items": { "$ref": "SasPortalDeploymentAssociation" }, "description": "Optional. A list of deployment association that were created for the migration, or current associations if they already exist.", "type": "array" } }, "id": "SasPortalMigrateOrganizationResponse", "description": "Response for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]." }, "SasPortalOrganization": { "type": "object", "properties": { "id": { "type": "string", "format": "int64", "description": "Id of organization" }, "displayName": { "type": "string", "description": "Name of organization" } }, "id": "SasPortalOrganization", "description": "Organization details." }, "SasPortalDevice": { "type": "object", "id": "SasPortalDevice", "properties": { "grants": { "type": "array", "items": { "$ref": "SasPortalDeviceGrant" }, "description": "Output only. Grants held by the device." }, "deviceMetadata": { "description": "Device parameters that can be overridden by both SAS Portal and SAS registration requests.", "$ref": "SasPortalDeviceMetadata" }, "preloadedConfig": { "description": "Configuration of the device, as specified via SAS Portal API.", "$ref": "SasPortalDeviceConfig" }, "state": { "enumDescriptions": [ "Unspecified state.", "Device created in the SAS Portal, however, not yet registered with SAS.", "Device registered with SAS.", "Device de-registered with SAS." ], "type": "string", "description": "Output only. Device state.", "enum": [ "DEVICE_STATE_UNSPECIFIED", "RESERVED", "REGISTERED", "DEREGISTERED" ] }, "displayName": { "description": "Device display name.", "type": "string" }, "activeConfig": { "$ref": "SasPortalDeviceConfig", "description": "Output only. Current configuration of the device as registered to the SAS." }, "grantRangeAllowlists": { "description": "Only ranges that are within the allowlists are available for new grants.", "type": "array", "items": { "$ref": "SasPortalFrequencyRange" } }, "name": { "description": "Output only. The resource path name.", "type": "string" }, "fccId": { "type": "string", "description": "The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them." }, "serialNumber": { "description": "A serial number assigned to the device by the device manufacturer.", "type": "string" }, "currentChannels": { "description": "Output only. Current channels with scores.", "items": { "$ref": "SasPortalChannelWithScore" }, "type": "array", "readOnly": true, "deprecated": true } } }, "SasPortalDeploymentAssociation": { "id": "SasPortalDeploymentAssociation", "type": "object", "properties": { "userId": { "type": "string", "description": "User id of the deployment." }, "gcpProjectId": { "description": "GCP project id of the associated project.", "type": "string" } }, "description": "Association between a gcp project and a SAS user id." }, "SasPortalOperation": { "properties": { "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object", "description": "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`." }, "name": { "type": "string", "description": "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}`." }, "done": { "description": "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.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "SasPortalStatus" }, "metadata": { "description": "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.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "id": "SasPortalOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object" }, "SasPortalListLegacyOrganizationsResponse": { "properties": { "organizations": { "type": "array", "items": { "$ref": "SasPortalOrganization" }, "description": "Optional. Legacy SAS organizations." } }, "type": "object", "id": "SasPortalListLegacyOrganizationsResponse", "description": "Response for [ListLegacyOrganizations]. [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]." }, "SasPortalGenerateSecretRequest": { "properties": {}, "id": "SasPortalGenerateSecretRequest", "description": "Request for GenerateSecret.", "type": "object" }, "SasPortalSetupSasAnalyticsMetadata": { "properties": {}, "type": "object", "description": "Metadata returned by the long running operation for the SetupSasAnalytics rpc.", "id": "SasPortalSetupSasAnalyticsMetadata" }, "SasPortalSetupSasAnalyticsRequest": { "properties": { "userId": { "description": "Optional. User id to setup analytics for, if not provided the user id associated with the project is used. optional", "type": "string" } }, "id": "SasPortalSetupSasAnalyticsRequest", "description": "Request for the SetupSasAnalytics rpc.", "type": "object" }, "SasPortalListDeploymentsResponse": { "description": "Response for ListDeployments.", "properties": { "deployments": { "description": "The deployments that match the request.", "type": "array", "items": { "$ref": "SasPortalDeployment" } }, "nextPageToken": { "type": "string", "description": "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." } }, "type": "object", "id": "SasPortalListDeploymentsResponse" }, "SasPortalMigrateOrganizationMetadata": { "properties": { "operationState": { "description": "Output only. Current operation state", "enumDescriptions": [ "Unspecified.", "Pending (Not started).", "In-progress.", "Done successfully.", "Done with errors." ], "enum": [ "OPERATION_STATE_UNSPECIFIED", "OPERATION_STATE_PENDING", "OPERATION_STATE_RUNNING", "OPERATION_STATE_SUCCEEDED", "OPERATION_STATE_FAILED" ], "readOnly": true, "type": "string" } }, "description": "Long-running operation metadata message returned by the MigrateOrganization.", "type": "object", "id": "SasPortalMigrateOrganizationMetadata" }, "SasPortalSetupSasAnalyticsResponse": { "description": "Response returned by the long running operation for the SetupSasAnalytics rpc.", "properties": {}, "type": "object", "id": "SasPortalSetupSasAnalyticsResponse" }, "SasPortalDeviceAirInterface": { "description": "Information about the device's air interface.", "properties": { "supportedSpec": { "description": "Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.", "type": "string" }, "radioTechnology": { "type": "string", "description": "Conditional. This field specifies the radio access technology that is used for the CBSD.", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "" ], "enum": [ "RADIO_TECHNOLOGY_UNSPECIFIED", "E_UTRA", "CAMBIUM_NETWORKS", "FOUR_G_BBW_SAA_1", "NR", "DOODLE_CBRS", "CW", "REDLINE", "TARANA_WIRELESS", "FAROS" ] } }, "id": "SasPortalDeviceAirInterface", "type": "object" }, "SasPortalListCustomersResponse": { "id": "SasPortalListCustomersResponse", "description": "Response for `ListCustomers`.", "type": "object", "properties": { "customers": { "items": { "$ref": "SasPortalCustomer" }, "description": "The list of customers that match the request.", "type": "array" }, "nextPageToken": { "description": "A pagination token returned from a previous call to ListCustomers that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers.", "type": "string" } } }, "SasPortalStatus": { "description": "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).", "type": "object", "id": "SasPortalStatus", "properties": { "message": { "description": "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.", "type": "string" }, "code": { "format": "int32", "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "SasPortalProvisionDeploymentRequest": { "properties": { "newDeploymentDisplayName": { "type": "string", "description": "Optional. If this field is set, and a new SAS Portal Deployment needs to be created, its display name will be set to the value of this field." }, "newOrganizationDisplayName": { "description": "Optional. If this field is set, and a new SAS Portal Organization needs to be created, its display name will be set to the value of this field.", "type": "string" }, "organizationId": { "format": "int64", "description": "Optional. If this field is set then a new deployment will be created under the organization specified by this id.", "type": "string" } }, "description": "Request for [ProvisionDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP Project, Organization Info, and caller’s GAIA ID should be retrieved from the RPC handler, and used as inputs to create a new SAS organization (if not exists) and a new SAS deployment.", "type": "object", "id": "SasPortalProvisionDeploymentRequest" }, "SasPortalDeviceConfig": { "id": "SasPortalDeviceConfig", "type": "object", "properties": { "airInterface": { "$ref": "SasPortalDeviceAirInterface", "description": "Information about this device's air interface." }, "isSigned": { "type": "boolean", "description": "Output only. Whether the configuration has been signed by a CPI." }, "userId": { "description": "The identifier of a device user.", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The last time the device configuration was edited." }, "model": { "description": "Information about this device model.", "$ref": "SasPortalDeviceModel" }, "installationParams": { "$ref": "SasPortalInstallationParams", "description": "Installation parameters for the device." }, "state": { "enum": [ "DEVICE_CONFIG_STATE_UNSPECIFIED", "DRAFT", "FINAL" ], "enumDescriptions": [ "", "", "" ], "type": "string", "description": "State of the configuration." }, "category": { "enum": [ "DEVICE_CATEGORY_UNSPECIFIED", "DEVICE_CATEGORY_A", "DEVICE_CATEGORY_B" ], "type": "string", "description": "FCC category of the device.", "enumDescriptions": [ "Unspecified device category.", "Category A.", "Category B." ] }, "callSign": { "description": "The call sign of the device operator.", "type": "string" }, "measurementCapabilities": { "type": "array", "description": "Measurement reporting capabilities of the device.", "items": { "type": "string", "enum": [ "MEASUREMENT_CAPABILITY_UNSPECIFIED", "MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT", "MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT" ], "enumDescriptions": [ "", "", "" ] } } }, "description": "Information about the device configuration." }, "SasPortalMoveDeploymentRequest": { "id": "SasPortalMoveDeploymentRequest", "description": "Request for MoveDeployment.", "type": "object", "properties": { "destination": { "type": "string", "description": "Required. The name of the new parent resource node or customer to reparent the deployment under." } } }, "SasPortalTestPermissionsResponse": { "id": "SasPortalTestPermissionsResponse", "description": "Response message for `TestPermissions` method.", "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "description": "A set of permissions that the caller is allowed.", "type": "array" } } }, "SasPortalDeviceModel": { "id": "SasPortalDeviceModel", "description": "Information about the model of the device.", "type": "object", "properties": { "hardwareVersion": { "description": "The hardware version of the device.", "type": "string" }, "name": { "description": "The name of the device model.", "type": "string" }, "softwareVersion": { "description": "The software version of the device.", "type": "string" }, "firmwareVersion": { "type": "string", "description": "The firmware version of the device." }, "vendor": { "type": "string", "description": "The name of the device vendor." } } }, "SasPortalSetPolicyRequest": { "properties": { "resource": { "type": "string", "description": "Required. The resource for which the policy is being specified. This policy replaces any existing policy." }, "disableNotification": { "type": "boolean", "description": "Optional. Set the field as `true` to disable the onboarding notification." }, "policy": { "description": "Required. The policy to be applied to the `resource`.", "$ref": "SasPortalPolicy" } }, "type": "object", "id": "SasPortalSetPolicyRequest", "description": "Request message for `SetPolicy` method." }, "SasPortalDeviceGrant": { "type": "object", "properties": { "expireTime": { "format": "google-datetime", "description": "The expiration time of the grant.", "type": "string" }, "grantId": { "type": "string", "description": "Grant Id." }, "frequencyRange": { "$ref": "SasPortalFrequencyRange", "description": "The transmission frequency range." }, "moveList": { "items": { "$ref": "SasPortalDpaMoveList" }, "type": "array", "description": "The DPA move lists on which this grant appears." }, "lastHeartbeatTransmitExpireTime": { "format": "google-datetime", "description": "The transmit expiration time of the last heartbeat.", "type": "string" }, "state": { "description": "State of the grant.", "enum": [ "GRANT_STATE_UNSPECIFIED", "GRANT_STATE_GRANTED", "GRANT_STATE_TERMINATED", "GRANT_STATE_SUSPENDED", "GRANT_STATE_AUTHORIZED", "GRANT_STATE_EXPIRED" ], "enumDescriptions": [ "", "The grant has been granted but the device is not heartbeating on it.", "The grant has been terminated by the SAS.", "The grant has been suspended by the SAS.", "The device is currently transmitting.", "The grant has expired." ], "type": "string" }, "suspensionReason": { "description": "If the grant is suspended, the reason(s) for suspension.", "type": "array", "items": { "type": "string" } }, "maxEirp": { "type": "number", "description": "Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).", "format": "double" }, "channelType": { "enumDescriptions": [ "", "", "" ], "type": "string", "enum": [ "CHANNEL_TYPE_UNSPECIFIED", "CHANNEL_TYPE_GAA", "CHANNEL_TYPE_PAL" ], "description": "Type of channel used." } }, "id": "SasPortalDeviceGrant", "description": "Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device." }, "SasPortalInstallationParams": { "description": "Information about the device installation parameters.", "properties": { "indoorDeployment": { "description": "Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.", "type": "boolean" }, "antennaDowntilt": { "description": "Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.", "type": "integer", "format": "int32" }, "cpeCbsdIndication": { "type": "boolean", "description": "If present, this parameter specifies whether the CBSD is a CPE-CBSD or not." }, "antennaModel": { "description": "If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.", "type": "string" }, "longitude": { "type": "number", "format": "double", "description": "Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian." }, "heightType": { "description": "Specifies how the height is measured.", "enumDescriptions": [ "Unspecified height type.", "AGL height is measured relative to the ground level.", "AMSL height is measured relative to the mean sea level." ], "type": "string", "enum": [ "HEIGHT_TYPE_UNSPECIFIED", "HEIGHT_TYPE_AGL", "HEIGHT_TYPE_AMSL" ] }, "horizontalAccuracy": { "format": "double", "description": "A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.", "type": "number" }, "height": { "type": "number", "format": "double", "description": "Device antenna height in meters. When the `heightType` parameter value is \"AGL\", the antenna height should be given relative to ground level. When the `heightType` parameter value is \"AMSL\", it is given with respect to WGS84 datum." }, "latitude": { "format": "double", "description": "Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.", "type": "number" }, "verticalAccuracy": { "format": "double", "description": "A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.", "type": "number" }, "antennaGain": { "format": "double", "type": "number", "description": "Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value" }, "eirpCapability": { "format": "int32", "description": "This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.", "type": "integer" }, "antennaBeamwidth": { "type": "integer", "description": "3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.", "format": "int32" }, "antennaAzimuth": { "format": "int32", "type": "integer", "description": "Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices." } }, "type": "object", "id": "SasPortalInstallationParams" }, "SasPortalListNodesResponse": { "properties": { "nodes": { "items": { "$ref": "SasPortalNode" }, "type": "array", "description": "The nodes that match the request." }, "nextPageToken": { "type": "string", "description": "A pagination token returned from a previous call to ListNodes that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes." } }, "id": "SasPortalListNodesResponse", "type": "object", "description": "Response for ListNodes." } }, "rootUrl": "https://sasportal.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "parameters": { "alt": { "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "location": "query", "description": "Data format for response." }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "$.xgafv": { "type": "string", "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "enum": [ "1", "2" ] }, "key": { "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" } }, "description": "", "kind": "discovery#restDescription", "batchPath": "batch", "resources": { "installer": { "methods": { "validate": { "response": { "$ref": "SasPortalValidateInstallerResponse" }, "description": "Validates the identity of a Certified Professional Installer (CPI).", "request": { "$ref": "SasPortalValidateInstallerRequest" }, "parameters": {}, "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/installer:validate", "path": "v1alpha1/installer:validate", "httpMethod": "POST", "id": "sasportal.installer.validate" }, "generateSecret": { "request": { "$ref": "SasPortalGenerateSecretRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "response": { "$ref": "SasPortalGenerateSecretResponse" }, "parameters": {}, "path": "v1alpha1/installer:generateSecret", "description": "Generates a secret to be used with the ValidateInstaller.", "id": "sasportal.installer.generateSecret", "flatPath": "v1alpha1/installer:generateSecret", "httpMethod": "POST", "parameterOrder": [] } } }, "nodes": { "methods": { "get": { "description": "Returns a requested node.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/nodes/{nodesId}", "id": "sasportal.nodes.get", "response": { "$ref": "SasPortalNode" }, "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the node.", "pattern": "^nodes/[^/]+$", "required": true, "type": "string" } } } }, "resources": { "deployments": { "resources": { "devices": { "methods": { "create": { "description": "Creates a device under a node or customer.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+parent}/devices", "flatPath": "v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices", "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "sasportal.nodes.deployments.devices.create", "response": { "$ref": "SasPortalDevice" }, "request": { "$ref": "SasPortalDevice" }, "parameters": { "parent": { "description": "Required. The name of the parent resource.", "required": true, "type": "string", "location": "path", "pattern": "^nodes/[^/]+/deployments/[^/]+$" } } }, "createSigned": { "flatPath": "v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned", "parameterOrder": [ "parent" ], "httpMethod": "POST", "request": { "$ref": "SasPortalCreateSignedDeviceRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.nodes.deployments.devices.createSigned", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The name of the parent resource.", "location": "path", "pattern": "^nodes/[^/]+/deployments/[^/]+$" } }, "response": { "$ref": "SasPortalDevice" }, "path": "v1alpha1/{+parent}/devices:createSigned", "description": "Creates a signed device under a node or customer." }, "list": { "parameters": { "pageSize": { "type": "integer", "description": "The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from." }, "filter": { "type": "string", "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query" }, "parent": { "required": true, "description": "Required. The name of the parent resource.", "location": "path", "pattern": "^nodes/[^/]+/deployments/[^/]+$", "type": "string" } }, "flatPath": "v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "description": "Lists devices under a node or customer.", "id": "sasportal.nodes.deployments.devices.list", "path": "v1alpha1/{+parent}/devices", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "SasPortalListDevicesResponse" } } } } }, "methods": { "delete": { "httpMethod": "DELETE", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "response": { "$ref": "SasPortalEmpty" }, "description": "Deletes a deployment.", "parameterOrder": [ "name" ], "id": "sasportal.nodes.deployments.delete", "parameters": { "name": { "description": "Required. The name of the deployment.", "pattern": "^nodes/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "flatPath": "v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}" }, "get": { "flatPath": "v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The name of the deployment.", "pattern": "^nodes/[^/]+/deployments/[^/]+$", "type": "string", "required": true } }, "id": "sasportal.nodes.deployments.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "response": { "$ref": "SasPortalDeployment" }, "description": "Returns a requested deployment." }, "list": { "parameters": { "pageToken": { "type": "string", "location": "query", "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from." }, "pageSize": { "description": "The maximum number of deployments to return in the response.", "format": "int32", "location": "query", "type": "integer" }, "parent": { "pattern": "^nodes/[^/]+$", "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", "location": "path", "type": "string", "required": true }, "filter": { "description": "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.", "location": "query", "type": "string" } }, "response": { "$ref": "SasPortalListDeploymentsResponse" }, "path": "v1alpha1/{+parent}/deployments", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.nodes.deployments.list", "description": "Lists deployments.", "httpMethod": "GET", "flatPath": "v1alpha1/nodes/{nodesId}/deployments" }, "move": { "flatPath": "v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "description": "Moves a deployment under another node or customer.", "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "sasportal.nodes.deployments.move", "path": "v1alpha1/{+name}:move", "response": { "$ref": "SasPortalOperation" }, "parameters": { "name": { "location": "path", "pattern": "^nodes/[^/]+/deployments/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the deployment to move." } }, "request": { "$ref": "SasPortalMoveDeploymentRequest" } }, "patch": { "parameters": { "updateMask": { "location": "query", "description": "Fields to be updated.", "type": "string", "format": "google-fieldmask" }, "name": { "type": "string", "pattern": "^nodes/[^/]+/deployments/[^/]+$", "description": "Output only. Resource name.", "required": true, "location": "path" } }, "description": "Updates an existing deployment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+name}", "request": { "$ref": "SasPortalDeployment" }, "response": { "$ref": "SasPortalDeployment" }, "id": "sasportal.nodes.deployments.patch", "flatPath": "v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}", "httpMethod": "PATCH", "parameterOrder": [ "name" ] } } }, "devices": { "methods": { "create": { "path": "v1alpha1/{+parent}/devices", "description": "Creates a device under a node or customer.", "parameters": { "parent": { "location": "path", "pattern": "^nodes/[^/]+$", "description": "Required. The name of the parent resource.", "type": "string", "required": true } }, "request": { "$ref": "SasPortalDevice" }, "response": { "$ref": "SasPortalDevice" }, "flatPath": "v1alpha1/nodes/{nodesId}/devices", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "httpMethod": "POST", "id": "sasportal.nodes.devices.create", "parameterOrder": [ "parent" ] }, "createSigned": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+parent}/devices:createSigned", "httpMethod": "POST", "flatPath": "v1alpha1/nodes/{nodesId}/devices:createSigned", "response": { "$ref": "SasPortalDevice" }, "description": "Creates a signed device under a node or customer.", "parameterOrder": [ "parent" ], "request": { "$ref": "SasPortalCreateSignedDeviceRequest" }, "id": "sasportal.nodes.devices.createSigned", "parameters": { "parent": { "location": "path", "pattern": "^nodes/[^/]+$", "required": true, "description": "Required. The name of the parent resource.", "type": "string" } } }, "patch": { "response": { "$ref": "SasPortalDevice" }, "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^nodes/[^/]+/devices/[^/]+$", "description": "Output only. The resource path name." }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Fields to be updated.", "type": "string" } }, "parameterOrder": [ "name" ], "id": "sasportal.nodes.devices.patch", "path": "v1alpha1/{+name}", "httpMethod": "PATCH", "request": { "$ref": "SasPortalDevice" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "description": "Updates a device.", "flatPath": "v1alpha1/nodes/{nodesId}/devices/{devicesId}" }, "signDevice": { "flatPath": "v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice", "path": "v1alpha1/{+name}:signDevice", "httpMethod": "POST", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.nodes.devices.signDevice", "parameters": { "name": { "location": "path", "description": "Output only. The resource path name.", "required": true, "pattern": "^nodes/[^/]+/devices/[^/]+$", "type": "string" } }, "description": "Signs a device.", "request": { "$ref": "SasPortalSignDeviceRequest" }, "response": { "$ref": "SasPortalEmpty" } }, "get": { "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "required": true, "pattern": "^nodes/[^/]+/devices/[^/]+$", "location": "path", "description": "Required. The name of the device." } }, "parameterOrder": [ "name" ], "description": "Gets details about a device.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/nodes/{nodesId}/devices/{devicesId}", "httpMethod": "GET", "id": "sasportal.nodes.devices.get", "response": { "$ref": "SasPortalDevice" } }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.nodes.devices.delete", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the device.", "pattern": "^nodes/[^/]+/devices/[^/]+$", "location": "path" } }, "response": { "$ref": "SasPortalEmpty" }, "description": "Deletes a device.", "httpMethod": "DELETE", "flatPath": "v1alpha1/nodes/{nodesId}/devices/{devicesId}", "path": "v1alpha1/{+name}" }, "updateSigned": { "id": "sasportal.nodes.devices.updateSigned", "response": { "$ref": "SasPortalDevice" }, "request": { "$ref": "SasPortalUpdateSignedDeviceRequest" }, "httpMethod": "PATCH", "path": "v1alpha1/{+name}:updateSigned", "description": "Updates a signed device.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned", "parameters": { "name": { "required": true, "description": "Required. The name of the device to update.", "type": "string", "pattern": "^nodes/[^/]+/devices/[^/]+$", "location": "path" } } }, "move": { "parameters": { "name": { "required": true, "description": "Required. The name of the device to move.", "type": "string", "location": "path", "pattern": "^nodes/[^/]+/devices/[^/]+$" } }, "response": { "$ref": "SasPortalOperation" }, "id": "sasportal.nodes.devices.move", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+name}:move", "parameterOrder": [ "name" ], "description": "Moves a device under another node or customer.", "request": { "$ref": "SasPortalMoveDeviceRequest" }, "httpMethod": "POST", "flatPath": "v1alpha1/nodes/{nodesId}/devices/{devicesId}:move" }, "list": { "id": "sasportal.nodes.devices.list", "response": { "$ref": "SasPortalListDevicesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameterOrder": [ "parent" ], "description": "Lists devices under a node or customer.", "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]." }, "parent": { "required": true, "location": "path", "description": "Required. The name of the parent resource.", "type": "string", "pattern": "^nodes/[^/]+$" }, "filter": { "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, "pageToken": { "description": "A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from.", "location": "query", "type": "string" } }, "flatPath": "v1alpha1/nodes/{nodesId}/devices", "path": "v1alpha1/{+parent}/devices" } } }, "nodes": { "resources": { "nodes": { "methods": { "create": { "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes", "request": { "$ref": "SasPortalNode" }, "parameters": { "parent": { "pattern": "^nodes/[^/]+/nodes/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource name where the node is to be created.", "required": true } }, "path": "v1alpha1/{+parent}/nodes", "description": "Creates a new node.", "id": "sasportal.nodes.nodes.nodes.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "response": { "$ref": "SasPortalNode" }, "httpMethod": "POST" }, "list": { "httpMethod": "GET", "id": "sasportal.nodes.nodes.nodes.list", "response": { "$ref": "SasPortalListNodesResponse" }, "description": "Lists nodes.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes", "path": "v1alpha1/{+parent}/nodes", "parameters": { "filter": { "description": "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 nodes are filtered.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of nodes to return in the response.", "location": "query" }, "parent": { "required": true, "location": "path", "pattern": "^nodes/[^/]+/nodes/[^/]+$", "description": "Required. The parent resource name, for example, \"nodes/1\".", "type": "string" } }, "parameterOrder": [ "parent" ] } } }, "deployments": { "methods": { "list": { "id": "sasportal.nodes.nodes.deployments.list", "response": { "$ref": "SasPortalListDeploymentsResponse" }, "httpMethod": "GET", "path": "v1alpha1/{+parent}/deployments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameterOrder": [ "parent" ], "parameters": { "filter": { "location": "query", "description": "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.", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The maximum number of deployments to return in the response." }, "parent": { "required": true, "pattern": "^nodes/[^/]+/nodes/[^/]+$", "type": "string", "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", "location": "path" }, "pageToken": { "type": "string", "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", "location": "query" } }, "description": "Lists deployments.", "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments" }, "create": { "httpMethod": "POST", "id": "sasportal.nodes.nodes.deployments.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments", "response": { "$ref": "SasPortalDeployment" }, "description": "Creates a new deployment.", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "description": "Required. The parent resource name where the deployment is to be created.", "type": "string", "pattern": "^nodes/[^/]+/nodes/[^/]+$", "required": true } }, "request": { "$ref": "SasPortalDeployment" }, "path": "v1alpha1/{+parent}/deployments" } } }, "devices": { "methods": { "list": { "description": "Lists devices under a node or customer.", "parameters": { "pageSize": { "description": "The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].", "type": "integer", "location": "query", "format": "int32" }, "parent": { "description": "Required. The name of the parent resource.", "location": "path", "pattern": "^nodes/[^/]+/nodes/[^/]+$", "required": true, "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from." }, "filter": { "type": "string", "location": "query", "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive." } }, "path": "v1alpha1/{+parent}/devices", "id": "sasportal.nodes.nodes.devices.list", "response": { "$ref": "SasPortalListDevicesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices", "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "createSigned": { "response": { "$ref": "SasPortalDevice" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "description": "Creates a signed device under a node or customer.", "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The name of the parent resource.", "pattern": "^nodes/[^/]+/nodes/[^/]+$", "required": true } }, "request": { "$ref": "SasPortalCreateSignedDeviceRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.nodes.nodes.devices.createSigned", "path": "v1alpha1/{+parent}/devices:createSigned" }, "create": { "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The name of the parent resource.", "pattern": "^nodes/[^/]+/nodes/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.nodes.nodes.devices.create", "description": "Creates a device under a node or customer.", "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices", "path": "v1alpha1/{+parent}/devices", "response": { "$ref": "SasPortalDevice" }, "parameterOrder": [ "parent" ], "request": { "$ref": "SasPortalDevice" }, "httpMethod": "POST" } } } }, "methods": { "patch": { "parameterOrder": [ "name" ], "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "description": "Updates an existing node.", "httpMethod": "PATCH", "parameters": { "name": { "required": true, "description": "Output only. Resource name.", "location": "path", "type": "string", "pattern": "^nodes/[^/]+/nodes/[^/]+$" }, "updateMask": { "location": "query", "type": "string", "description": "Fields to be updated.", "format": "google-fieldmask" } }, "path": "v1alpha1/{+name}", "request": { "$ref": "SasPortalNode" }, "response": { "$ref": "SasPortalNode" }, "id": "sasportal.nodes.nodes.patch" }, "get": { "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}", "description": "Returns a requested node.", "parameters": { "name": { "pattern": "^nodes/[^/]+/nodes/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the node.", "location": "path" } }, "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "id": "sasportal.nodes.nodes.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "response": { "$ref": "SasPortalNode" } }, "list": { "parameters": { "pageToken": { "location": "query", "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "type": "string" }, "parent": { "pattern": "^nodes/[^/]+$", "description": "Required. The parent resource name, for example, \"nodes/1\".", "required": true, "type": "string", "location": "path" }, "filter": { "location": "query", "description": "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 nodes are filtered.", "type": "string" }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "type": "integer", "format": "int32", "location": "query" } }, "description": "Lists nodes.", "flatPath": "v1alpha1/nodes/{nodesId}/nodes", "path": "v1alpha1/{+parent}/nodes", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "SasPortalListNodesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.nodes.nodes.list" }, "create": { "path": "v1alpha1/{+parent}/nodes", "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The parent resource name where the node is to be created.", "required": true, "pattern": "^nodes/[^/]+$" } }, "description": "Creates a new node.", "flatPath": "v1alpha1/nodes/{nodesId}/nodes", "id": "sasportal.nodes.nodes.create", "request": { "$ref": "SasPortalNode" }, "parameterOrder": [ "parent" ], "response": { "$ref": "SasPortalNode" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "httpMethod": "POST" }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "SasPortalEmpty" }, "id": "sasportal.nodes.nodes.delete", "path": "v1alpha1/{+name}", "parameters": { "name": { "pattern": "^nodes/[^/]+/nodes/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the node.", "location": "path" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "description": "Deletes a node.", "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}" }, "move": { "parameterOrder": [ "name" ], "response": { "$ref": "SasPortalOperation" }, "parameters": { "name": { "location": "path", "description": "Required. The name of the node to move.", "required": true, "type": "string", "pattern": "^nodes/[^/]+/nodes/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+name}:move", "description": "Moves a node under another node or customer.", "id": "sasportal.nodes.nodes.move", "request": { "$ref": "SasPortalMoveNodeRequest" }, "httpMethod": "POST", "flatPath": "v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move" } } } } }, "policies": { "methods": { "get": { "path": "v1alpha1/policies:get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/policies:get", "httpMethod": "POST", "request": { "$ref": "SasPortalGetPolicyRequest" }, "id": "sasportal.policies.get", "response": { "$ref": "SasPortalPolicy" }, "parameters": {}, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameterOrder": [] }, "set": { "httpMethod": "POST", "path": "v1alpha1/policies:set", "response": { "$ref": "SasPortalPolicy" }, "parameterOrder": [], "flatPath": "v1alpha1/policies:set", "id": "sasportal.policies.set", "request": { "$ref": "SasPortalSetPolicyRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameters": {}, "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "test": { "parameters": {}, "id": "sasportal.policies.test", "flatPath": "v1alpha1/policies:test", "path": "v1alpha1/policies:test", "description": "Returns permissions that a caller has on the specified resource.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "response": { "$ref": "SasPortalTestPermissionsResponse" }, "parameterOrder": [], "request": { "$ref": "SasPortalTestPermissionsRequest" }, "httpMethod": "POST" } } }, "customers": { "methods": { "patch": { "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1alpha1/customers/{customersId}", "id": "sasportal.customers.patch", "parameters": { "updateMask": { "description": "Fields to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "location": "path", "required": true, "description": "Output only. Resource name of the customer.", "type": "string", "pattern": "^customers/[^/]+$" } }, "description": "Updates an existing customer.", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "request": { "$ref": "SasPortalCustomer" }, "response": { "$ref": "SasPortalCustomer" } }, "listGcpProjectDeployments": { "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/customers:listGcpProjectDeployments", "id": "sasportal.customers.listGcpProjectDeployments", "parameterOrder": [], "description": "Returns a list of SAS deployments associated with current GCP project. Includes whether SAS analytics has been enabled or not.", "httpMethod": "GET", "path": "v1alpha1/customers:listGcpProjectDeployments", "response": { "$ref": "SasPortalListGcpProjectDeploymentsResponse" } }, "list": { "id": "sasportal.customers.list", "response": { "$ref": "SasPortalListCustomersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/customers", "httpMethod": "GET", "parameterOrder": [], "description": "Returns a list of requested customers.", "parameters": { "pageSize": { "format": "int32", "description": "The maximum number of customers to return in the response.", "location": "query", "type": "integer" }, "pageToken": { "description": "A pagination token returned from a previous call to ListCustomers that indicates where this listing should continue from.", "type": "string", "location": "query" } }, "flatPath": "v1alpha1/customers" }, "provisionDeployment": { "description": "Creates a new SAS deployment through the GCP workflow. Creates a SAS organization if an organization match is not found.", "response": { "$ref": "SasPortalProvisionDeploymentResponse" }, "request": { "$ref": "SasPortalProvisionDeploymentRequest" }, "id": "sasportal.customers.provisionDeployment", "httpMethod": "POST", "parameterOrder": [], "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/customers:provisionDeployment", "path": "v1alpha1/customers:provisionDeployment" }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1alpha1/customers/{customersId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+name}", "id": "sasportal.customers.get", "parameters": { "name": { "pattern": "^customers/[^/]+$", "location": "path", "description": "Required. The name of the customer.", "type": "string", "required": true } }, "httpMethod": "GET", "response": { "$ref": "SasPortalCustomer" }, "description": "Returns a requested customer." }, "migrateOrganization": { "response": { "$ref": "SasPortalOperation" }, "id": "sasportal.customers.migrateOrganization", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameters": {}, "httpMethod": "POST", "path": "v1alpha1/customers:migrateOrganization", "request": { "$ref": "SasPortalMigrateOrganizationRequest" }, "flatPath": "v1alpha1/customers:migrateOrganization", "description": "Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration", "parameterOrder": [] }, "setupSasAnalytics": { "response": { "$ref": "SasPortalOperation" }, "httpMethod": "POST", "path": "v1alpha1/customers:setupSasAnalytics", "request": { "$ref": "SasPortalSetupSasAnalyticsRequest" }, "description": "Setups the a GCP Project to receive SAS Analytics messages via GCP Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and BigQuery tables are created automatically as part of this service.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameters": {}, "id": "sasportal.customers.setupSasAnalytics", "flatPath": "v1alpha1/customers:setupSasAnalytics", "parameterOrder": [] }, "listLegacyOrganizations": { "flatPath": "v1alpha1/customers:listLegacyOrganizations", "description": "Returns a list of legacy organizations.", "parameters": {}, "path": "v1alpha1/customers:listLegacyOrganizations", "httpMethod": "GET", "parameterOrder": [], "id": "sasportal.customers.listLegacyOrganizations", "response": { "$ref": "SasPortalListLegacyOrganizationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ] } }, "resources": { "nodes": { "resources": { "nodes": { "methods": { "create": { "parameters": { "parent": { "type": "string", "required": true, "pattern": "^customers/[^/]+/nodes/[^/]+$", "description": "Required. The parent resource name where the node is to be created.", "location": "path" } }, "request": { "$ref": "SasPortalNode" }, "response": { "$ref": "SasPortalNode" }, "description": "Creates a new node.", "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes", "path": "v1alpha1/{+parent}/nodes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.customers.nodes.nodes.create", "httpMethod": "POST" }, "list": { "path": "v1alpha1/{+parent}/nodes", "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes", "parameters": { "pageToken": { "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "pattern": "^customers/[^/]+/nodes/[^/]+$", "location": "path", "description": "Required. The parent resource name, for example, \"nodes/1\"." }, "filter": { "location": "query", "description": "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 nodes are filtered.", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "description": "The maximum number of nodes to return in the response.", "format": "int32" } }, "description": "Lists nodes.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "SasPortalListNodesResponse" }, "id": "sasportal.customers.nodes.nodes.list" } } }, "devices": { "methods": { "create": { "description": "Creates a device under a node or customer.", "parameterOrder": [ "parent" ], "id": "sasportal.customers.nodes.devices.create", "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}/devices", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "httpMethod": "POST", "response": { "$ref": "SasPortalDevice" }, "parameters": { "parent": { "description": "Required. The name of the parent resource.", "type": "string", "required": true, "pattern": "^customers/[^/]+/nodes/[^/]+$", "location": "path" } }, "path": "v1alpha1/{+parent}/devices", "request": { "$ref": "SasPortalDevice" } }, "list": { "parameterOrder": [ "parent" ], "id": "sasportal.customers.nodes.devices.list", "httpMethod": "GET", "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}/devices", "parameters": { "parent": { "description": "Required. The name of the parent resource.", "location": "path", "pattern": "^customers/[^/]+/nodes/[^/]+$", "required": true, "type": "string" }, "filter": { "type": "string", "location": "query", "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive." }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].", "type": "integer" }, "pageToken": { "location": "query", "type": "string", "description": "A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from." } }, "path": "v1alpha1/{+parent}/devices", "response": { "$ref": "SasPortalListDevicesResponse" }, "description": "Lists devices under a node or customer.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ] }, "createSigned": { "path": "v1alpha1/{+parent}/devices:createSigned", "description": "Creates a signed device under a node or customer.", "response": { "$ref": "SasPortalDevice" }, "parameters": { "parent": { "required": true, "location": "path", "type": "string", "pattern": "^customers/[^/]+/nodes/[^/]+$", "description": "Required. The name of the parent resource." } }, "request": { "$ref": "SasPortalCreateSignedDeviceRequest" }, "id": "sasportal.customers.nodes.devices.createSigned", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned", "httpMethod": "POST" } } }, "deployments": { "methods": { "list": { "httpMethod": "GET", "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments", "path": "v1alpha1/{+parent}/deployments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.customers.nodes.deployments.list", "parameterOrder": [ "parent" ], "description": "Lists deployments.", "parameters": { "parent": { "type": "string", "pattern": "^customers/[^/]+/nodes/[^/]+$", "required": true, "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", "location": "path" }, "pageToken": { "type": "string", "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", "location": "query" }, "filter": { "description": "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.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The maximum number of deployments to return in the response." } }, "response": { "$ref": "SasPortalListDeploymentsResponse" } }, "create": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments", "request": { "$ref": "SasPortalDeployment" }, "description": "Creates a new deployment.", "path": "v1alpha1/{+parent}/deployments", "response": { "$ref": "SasPortalDeployment" }, "id": "sasportal.customers.nodes.deployments.create", "parameters": { "parent": { "description": "Required. The parent resource name where the deployment is to be created.", "location": "path", "type": "string", "required": true, "pattern": "^customers/[^/]+/nodes/[^/]+$" } } } } } }, "methods": { "move": { "description": "Moves a node under another node or customer.", "path": "v1alpha1/{+name}:move", "request": { "$ref": "SasPortalMoveNodeRequest" }, "response": { "$ref": "SasPortalOperation" }, "httpMethod": "POST", "id": "sasportal.customers.nodes.move", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the node to move.", "location": "path", "pattern": "^customers/[^/]+/nodes/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}:move", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ] }, "create": { "flatPath": "v1alpha1/customers/{customersId}/nodes", "parameters": { "parent": { "description": "Required. The parent resource name where the node is to be created.", "type": "string", "location": "path", "pattern": "^customers/[^/]+$", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.customers.nodes.create", "description": "Creates a new node.", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/nodes", "request": { "$ref": "SasPortalNode" }, "httpMethod": "POST", "response": { "$ref": "SasPortalNode" } }, "delete": { "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}", "description": "Deletes a node.", "parameters": { "name": { "location": "path", "description": "Required. The name of the node.", "required": true, "pattern": "^customers/[^/]+/nodes/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+name}", "id": "sasportal.customers.nodes.delete", "response": { "$ref": "SasPortalEmpty" }, "httpMethod": "DELETE" }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.customers.nodes.list", "flatPath": "v1alpha1/customers/{customersId}/nodes", "parameterOrder": [ "parent" ], "description": "Lists nodes.", "response": { "$ref": "SasPortalListNodesResponse" }, "path": "v1alpha1/{+parent}/nodes", "parameters": { "pageToken": { "location": "query", "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The maximum number of nodes to return in the response." }, "filter": { "description": "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 nodes are filtered.", "location": "query", "type": "string" }, "parent": { "pattern": "^customers/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource name, for example, \"nodes/1\".", "location": "path" } } }, "get": { "id": "sasportal.customers.nodes.get", "parameterOrder": [ "name" ], "description": "Returns a requested node.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "httpMethod": "GET", "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}", "parameters": { "name": { "pattern": "^customers/[^/]+/nodes/[^/]+$", "description": "Required. The name of the node.", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "SasPortalNode" }, "path": "v1alpha1/{+name}" }, "patch": { "description": "Updates an existing node.", "httpMethod": "PATCH", "response": { "$ref": "SasPortalNode" }, "parameterOrder": [ "name" ], "id": "sasportal.customers.nodes.patch", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "request": { "$ref": "SasPortalNode" }, "flatPath": "v1alpha1/customers/{customersId}/nodes/{nodesId}", "parameters": { "name": { "type": "string", "location": "path", "description": "Output only. Resource name.", "pattern": "^customers/[^/]+/nodes/[^/]+$", "required": true }, "updateMask": { "location": "query", "type": "string", "description": "Fields to be updated.", "format": "google-fieldmask" } } } } }, "deployments": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.customers.deployments.get", "parameters": { "name": { "pattern": "^customers/[^/]+/deployments/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the deployment.", "type": "string" } }, "response": { "$ref": "SasPortalDeployment" }, "flatPath": "v1alpha1/customers/{customersId}/deployments/{deploymentsId}", "httpMethod": "GET", "path": "v1alpha1/{+name}", "description": "Returns a requested deployment.", "parameterOrder": [ "name" ] }, "patch": { "parameters": { "name": { "pattern": "^customers/[^/]+/deployments/[^/]+$", "type": "string", "required": true, "description": "Output only. Resource name.", "location": "path" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Fields to be updated." } }, "flatPath": "v1alpha1/customers/{customersId}/deployments/{deploymentsId}", "request": { "$ref": "SasPortalDeployment" }, "parameterOrder": [ "name" ], "description": "Updates an existing deployment.", "path": "v1alpha1/{+name}", "id": "sasportal.customers.deployments.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "response": { "$ref": "SasPortalDeployment" }, "httpMethod": "PATCH" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+parent}/deployments", "httpMethod": "GET", "response": { "$ref": "SasPortalListDeploymentsResponse" }, "description": "Lists deployments.", "parameterOrder": [ "parent" ], "id": "sasportal.customers.deployments.list", "flatPath": "v1alpha1/customers/{customersId}/deployments", "parameters": { "filter": { "location": "query", "description": "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.", "type": "string" }, "pageToken": { "location": "query", "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", "type": "string" }, "parent": { "location": "path", "type": "string", "required": true, "pattern": "^customers/[^/]+$", "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2." }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The maximum number of deployments to return in the response." } } }, "create": { "response": { "$ref": "SasPortalDeployment" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+parent}/deployments", "parameters": { "parent": { "pattern": "^customers/[^/]+$", "type": "string", "required": true, "description": "Required. The parent resource name where the deployment is to be created.", "location": "path" } }, "httpMethod": "POST", "description": "Creates a new deployment.", "id": "sasportal.customers.deployments.create", "flatPath": "v1alpha1/customers/{customersId}/deployments", "request": { "$ref": "SasPortalDeployment" } }, "delete": { "path": "v1alpha1/{+name}", "response": { "$ref": "SasPortalEmpty" }, "httpMethod": "DELETE", "description": "Deletes a deployment.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/customers/{customersId}/deployments/{deploymentsId}", "id": "sasportal.customers.deployments.delete", "parameters": { "name": { "required": true, "type": "string", "pattern": "^customers/[^/]+/deployments/[^/]+$", "location": "path", "description": "Required. The name of the deployment." } } }, "move": { "httpMethod": "POST", "id": "sasportal.customers.deployments.move", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameterOrder": [ "name" ], "flatPath": "v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move", "response": { "$ref": "SasPortalOperation" }, "description": "Moves a deployment under another node or customer.", "request": { "$ref": "SasPortalMoveDeploymentRequest" }, "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the deployment to move.", "location": "path", "pattern": "^customers/[^/]+/deployments/[^/]+$" } }, "path": "v1alpha1/{+name}:move" } }, "resources": { "devices": { "methods": { "list": { "response": { "$ref": "SasPortalListDevicesResponse" }, "description": "Lists devices under a node or customer.", "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^customers/[^/]+/deployments/[^/]+$", "description": "Required. The name of the parent resource.", "required": true }, "pageToken": { "location": "query", "description": "A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from.", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive." }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].", "type": "integer" } }, "path": "v1alpha1/{+parent}/devices", "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "sasportal.customers.deployments.devices.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "flatPath": "v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices" }, "createSigned": { "parameters": { "parent": { "location": "path", "description": "Required. The name of the parent resource.", "type": "string", "required": true, "pattern": "^customers/[^/]+/deployments/[^/]+$" } }, "response": { "$ref": "SasPortalDevice" }, "description": "Creates a signed device under a node or customer.", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/devices:createSigned", "request": { "$ref": "SasPortalCreateSignedDeviceRequest" }, "id": "sasportal.customers.deployments.devices.createSigned", "httpMethod": "POST", "flatPath": "v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "response": { "$ref": "SasPortalDevice" }, "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The name of the parent resource.", "required": true, "pattern": "^customers/[^/]+/deployments/[^/]+$" } }, "id": "sasportal.customers.deployments.devices.create", "request": { "$ref": "SasPortalDevice" }, "description": "Creates a device under a node or customer.", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/devices", "httpMethod": "POST", "flatPath": "v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices" } } } } }, "devices": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "httpMethod": "DELETE", "response": { "$ref": "SasPortalEmpty" }, "parameters": { "name": { "description": "Required. The name of the device.", "location": "path", "pattern": "^customers/[^/]+/devices/[^/]+$", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "id": "sasportal.customers.devices.delete", "flatPath": "v1alpha1/customers/{customersId}/devices/{devicesId}", "path": "v1alpha1/{+name}", "description": "Deletes a device." }, "move": { "httpMethod": "POST", "response": { "$ref": "SasPortalOperation" }, "id": "sasportal.customers.devices.move", "description": "Moves a device under another node or customer.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "request": { "$ref": "SasPortalMoveDeviceRequest" }, "path": "v1alpha1/{+name}:move", "parameters": { "name": { "location": "path", "pattern": "^customers/[^/]+/devices/[^/]+$", "description": "Required. The name of the device to move.", "type": "string", "required": true } }, "flatPath": "v1alpha1/customers/{customersId}/devices/{devicesId}:move" }, "updateSigned": { "parameterOrder": [ "name" ], "httpMethod": "PATCH", "id": "sasportal.customers.devices.updateSigned", "request": { "$ref": "SasPortalUpdateSignedDeviceRequest" }, "response": { "$ref": "SasPortalDevice" }, "description": "Updates a signed device.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+name}:updateSigned", "flatPath": "v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned", "parameters": { "name": { "description": "Required. The name of the device to update.", "required": true, "type": "string", "pattern": "^customers/[^/]+/devices/[^/]+$", "location": "path" } } }, "list": { "flatPath": "v1alpha1/customers/{customersId}/devices", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/devices", "parameters": { "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]." }, "pageToken": { "location": "query", "description": "A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from.", "type": "string" }, "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The name of the parent resource.", "pattern": "^customers/[^/]+$" }, "filter": { "type": "string", "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query" } }, "httpMethod": "GET", "response": { "$ref": "SasPortalListDevicesResponse" }, "id": "sasportal.customers.devices.list", "description": "Lists devices under a node or customer." }, "get": { "httpMethod": "GET", "flatPath": "v1alpha1/customers/{customersId}/devices/{devicesId}", "id": "sasportal.customers.devices.get", "response": { "$ref": "SasPortalDevice" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "description": "Gets details about a device.", "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^customers/[^/]+/devices/[^/]+$", "description": "Required. The name of the device.", "required": true, "type": "string", "location": "path" } } }, "create": { "parameters": { "parent": { "required": true, "pattern": "^customers/[^/]+$", "description": "Required. The name of the parent resource.", "location": "path", "type": "string" } }, "description": "Creates a device under a node or customer.", "response": { "$ref": "SasPortalDevice" }, "id": "sasportal.customers.devices.create", "request": { "$ref": "SasPortalDevice" }, "flatPath": "v1alpha1/customers/{customersId}/devices", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "v1alpha1/{+parent}/devices" }, "signDevice": { "request": { "$ref": "SasPortalSignDeviceRequest" }, "parameterOrder": [ "name" ], "response": { "$ref": "SasPortalEmpty" }, "parameters": { "name": { "location": "path", "type": "string", "pattern": "^customers/[^/]+/devices/[^/]+$", "required": true, "description": "Output only. The resource path name." } }, "flatPath": "v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.customers.devices.signDevice", "httpMethod": "POST", "path": "v1alpha1/{+name}:signDevice", "description": "Signs a device." }, "createSigned": { "description": "Creates a signed device under a node or customer.", "flatPath": "v1alpha1/customers/{customersId}/devices:createSigned", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "request": { "$ref": "SasPortalCreateSignedDeviceRequest" }, "httpMethod": "POST", "path": "v1alpha1/{+parent}/devices:createSigned", "parameters": { "parent": { "required": true, "pattern": "^customers/[^/]+$", "location": "path", "description": "Required. The name of the parent resource.", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "sasportal.customers.devices.createSigned", "response": { "$ref": "SasPortalDevice" } }, "patch": { "parameters": { "name": { "pattern": "^customers/[^/]+/devices/[^/]+$", "required": true, "description": "Output only. The resource path name.", "type": "string", "location": "path" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Fields to be updated.", "location": "query" } }, "response": { "$ref": "SasPortalDevice" }, "description": "Updates a device.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+name}", "id": "sasportal.customers.devices.patch", "flatPath": "v1alpha1/customers/{customersId}/devices/{devicesId}", "httpMethod": "PATCH", "request": { "$ref": "SasPortalDevice" } } } } } }, "deployments": { "resources": { "devices": { "methods": { "signDevice": { "description": "Signs a device.", "httpMethod": "POST", "flatPath": "v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice", "id": "sasportal.deployments.devices.signDevice", "path": "v1alpha1/{+name}:signDevice", "response": { "$ref": "SasPortalEmpty" }, "parameters": { "name": { "description": "Output only. The resource path name.", "required": true, "pattern": "^deployments/[^/]+/devices/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SasPortalSignDeviceRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ] }, "get": { "flatPath": "v1alpha1/deployments/{deploymentsId}/devices/{devicesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "description": "Gets details about a device.", "parameters": { "name": { "pattern": "^deployments/[^/]+/devices/[^/]+$", "required": true, "description": "Required. The name of the device.", "location": "path", "type": "string" } }, "id": "sasportal.deployments.devices.get", "response": { "$ref": "SasPortalDevice" } }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "SasPortalDevice" }, "httpMethod": "PATCH", "response": { "$ref": "SasPortalDevice" }, "flatPath": "v1alpha1/deployments/{deploymentsId}/devices/{devicesId}", "id": "sasportal.deployments.devices.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "path": "v1alpha1/{+name}", "parameters": { "updateMask": { "location": "query", "description": "Fields to be updated.", "format": "google-fieldmask", "type": "string" }, "name": { "pattern": "^deployments/[^/]+/devices/[^/]+$", "description": "Output only. The resource path name.", "type": "string", "location": "path", "required": true } }, "description": "Updates a device." }, "updateSigned": { "flatPath": "v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned", "path": "v1alpha1/{+name}:updateSigned", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "description": "Updates a signed device.", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "request": { "$ref": "SasPortalUpdateSignedDeviceRequest" }, "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the device to update.", "pattern": "^deployments/[^/]+/devices/[^/]+$", "required": true } }, "id": "sasportal.deployments.devices.updateSigned", "response": { "$ref": "SasPortalDevice" } }, "delete": { "flatPath": "v1alpha1/deployments/{deploymentsId}/devices/{devicesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "id": "sasportal.deployments.devices.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the device.", "location": "path", "pattern": "^deployments/[^/]+/devices/[^/]+$", "required": true } }, "description": "Deletes a device.", "response": { "$ref": "SasPortalEmpty" }, "path": "v1alpha1/{+name}" }, "move": { "response": { "$ref": "SasPortalOperation" }, "path": "v1alpha1/{+name}:move", "httpMethod": "POST", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameters": { "name": { "required": true, "description": "Required. The name of the device to move.", "type": "string", "location": "path", "pattern": "^deployments/[^/]+/devices/[^/]+$" } }, "id": "sasportal.deployments.devices.move", "request": { "$ref": "SasPortalMoveDeviceRequest" }, "flatPath": "v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move", "description": "Moves a device under another node or customer." } } } }, "methods": { "get": { "description": "Returns a requested deployment.", "parameters": { "name": { "pattern": "^deployments/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the deployment.", "type": "string" } }, "flatPath": "v1alpha1/deployments/{deploymentsId}", "id": "sasportal.deployments.get", "httpMethod": "GET", "response": { "$ref": "SasPortalDeployment" }, "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/sasportal" ], "parameterOrder": [ "name" ] } } } }, "ownerDomain": "google.com", "discoveryVersion": "v1", "protocol": "rest", "servicePath": "", "documentationLink": "https://developers.google.com/spectrum-access-system/", "fullyEncodeReservedExpansion": true, "version_module": true, "name": "sasportal", "mtlsRootUrl": "https://sasportal.mtls.googleapis.com/", "baseUrl": "https://sasportal.googleapis.com/", "id": "sasportal:v1alpha1", "version": "v1alpha1" }