{ "id": "networkconnectivity:v1alpha1", "schemas": { "RouterApplianceInstance": { "id": "RouterApplianceInstance", "properties": { "networkInterface": { "deprecated": true, "type": "string" }, "virtualMachine": { "description": "The URI of the virtual machine resource", "type": "string" }, "ipAddress": { "description": "The IP address of the network interface to use for peering.", "type": "string" } }, "description": "RouterAppliance represents a Router appliance which is specified by a VM URI and a NIC address.", "type": "object" }, "Location": { "type": "object", "id": "Location", "properties": { "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" } }, "description": "A resource that represents a Google Cloud location." }, "Expr": { "id": "Expr", "properties": { "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" } }, "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object" }, "ListSpokesResponse": { "type": "object", "description": "The response for HubService.ListSpokes.", "id": "ListSpokesResponse", "properties": { "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "spokes": { "type": "array", "description": "Spokes to be returned.", "items": { "$ref": "Spoke" } }, "nextPageToken": { "description": "The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.", "type": "string" } } }, "Binding": { "type": "object", "id": "Binding", "properties": { "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, "type": "array" }, "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "Expr" } }, "description": "Associates `members`, or principals, with a `role`." }, "OperationMetadata": { "type": "object", "id": "OperationMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "format": "google-datetime", "readOnly": true, "type": "string" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string", "readOnly": true }, "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string", "readOnly": true } }, "description": "Represents the metadata of the long-running operation." }, "AllocationOptions": { "type": "object", "id": "AllocationOptions", "properties": { "allocationStrategy": { "enumDescriptions": [ "Unspecified is the only valid option when the range is specified explicitly by ip_cidr_range field. Otherwise unspefified means using the default strategy.", "Random strategy, the legacy algorithm, used for backwards compatibility. This allocation strategy remains efficient in the case of concurrent allocation requests in the same peered network space and doesn't require providing the level of concurrency in an explicit parameter, but it is prone to fragmenting available address space.", "Pick the first available address range. This strategy is deterministic and the result is easy to predict.", "Pick an arbitrary range out of the first N available ones. The N will be set in the first_available_ranges_lookup_size field. This strategy should be used when concurrent allocation requests are made in the same space of peered networks while the fragmentation of the addrress space is reduced.", "Pick the smallest but fitting available range. This deterministic strategy minimizes fragmentation of the address space." ], "description": "Optional. Allocation strategy. Not setting this field when the allocation is requested means an implementation defined strategy is used.", "type": "string", "enum": [ "ALLOCATION_STRATEGY_UNSPECIFIED", "RANDOM", "FIRST_AVAILABLE", "RANDOM_FIRST_N_AVAILABLE", "FIRST_SMALLEST_FITTING" ] }, "firstAvailableRangesLookupSize": { "type": "integer", "description": "Optional. This field must be set only when allocation_strategy is set to RANDOM_FIRST_N_AVAILABLE. The value should be the maximum expected parallelism of range creation requests issued to the same space of peered netwroks.", "format": "int32" } }, "description": "Range auto-allocation options, to be optionally used when CIDR block is not explicitly set." }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", "properties": { "updateMask": { "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" }, "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "Policy" } }, "type": "object" }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", "properties": { "service": { "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" }, "auditLogConfigs": { "type": "array", "description": "The configuration for logging of each type of permission.", "items": { "$ref": "AuditLogConfig" } } }, "type": "object" }, "TestIamPermissionsRequest": { "type": "object", "id": "TestIamPermissionsRequest", "properties": { "permissions": { "type": "array", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" } } }, "description": "Request message for `TestIamPermissions` method." }, "Policy": { "id": "Policy", "properties": { "version": { "type": "integer", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32" }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "AuditConfig" }, "type": "array" }, "etag": { "type": "string", "description": "`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 `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte" }, "bindings": { "type": "array", "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "items": { "$ref": "Binding" } } }, "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "type": "object" }, "Hub": { "id": "Hub", "properties": { "name": { "description": "Immutable. The name of a Hub resource.", "type": "string" }, "labels": { "type": "object", "description": "User-defined labels.", "additionalProperties": { "type": "string" } }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED" ], "description": "Output only. The current lifecycle state of this Hub.", "enumDescriptions": [ "No state information available", "The resource's create operation is in progress", "The resource is active", "The resource's Delete operation is in progress", "The resource's Update operation is in progress", "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true }, "updateTime": { "description": "Time when the Hub was updated.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "description": "Time when the Hub was created.", "format": "google-datetime" }, "spokes": { "type": "array", "description": "Output only. A list of the URIs of all attached spokes. This field is deprecated and will not be included in future API versions. Call ListSpokes on each region instead.", "readOnly": true, "items": { "type": "string" }, "deprecated": true }, "uniqueId": { "description": "Output only. Google-generated UUID for this resource. This is unique across all Hub resources. If a Hub resource is deleted and another with the same name is created, it gets a different unique_id.", "type": "string", "readOnly": true }, "description": { "description": "Short description of the hub resource.", "type": "string" } }, "description": "Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model. Following is the resource message of a hub.", "type": "object" }, "GoogleLongrunningOperation": { "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation", "properties": { "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" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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`.", "type": "object" }, "name": { "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}`.", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" } } }, "GoogleLongrunningCancelOperationRequest": { "id": "GoogleLongrunningCancelOperationRequest", "properties": {}, "description": "The request message for Operations.CancelOperation.", "type": "object" }, "InternalRange": { "id": "InternalRange", "properties": { "description": { "description": "Optional. A description of this resource.", "type": "string" }, "network": { "description": "Optional. The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network}", "type": "string" }, "name": { "description": "Identifier. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names", "type": "string" }, "prefixLength": { "description": "Optional. An alternative to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter.", "format": "int32", "type": "integer" }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Time when the internal range was created.", "format": "google-datetime" }, "usage": { "type": "string", "enum": [ "USAGE_UNSPECIFIED", "FOR_VPC", "EXTERNAL_TO_VPC", "FOR_MIGRATION" ], "enumDescriptions": [ "Unspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.", "A VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.", "Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.", "Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION the peering value has to be set to FOR_SELF or default to FOR_SELF when unset." ], "description": "Optional. The type of usage set for this internal range." }, "overlaps": { "description": "Optional. Types of resources that are allowed to overlap with the current internal range.", "items": { "enumDescriptions": [ "No overlap overrides.", "Allow creation of static routes more specific than the current internal range.", "Allow creation of internal ranges that overlap with existing subnets." ], "type": "string", "enum": [ "OVERLAP_UNSPECIFIED", "OVERLAP_ROUTE_RANGE", "OVERLAP_EXISTING_SUBNET_RANGE" ] }, "type": "array" }, "excludeCidrRanges": { "type": "array", "description": "Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks", "items": { "type": "string" } }, "peering": { "description": "Optional. The type of peering set for this internal range.", "enumDescriptions": [ "If Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.", "This is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.", "This behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.", "This behavior can be set when the internal range is being reserved for usage by the VPC in which it is created but not shared with the peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too." ], "type": "string", "enum": [ "PEERING_UNSPECIFIED", "FOR_SELF", "FOR_PEER", "NOT_SHARED" ] }, "users": { "readOnly": true, "type": "array", "description": "Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range that is referred to. Can be empty.", "items": { "type": "string" } }, "allocationOptions": { "description": "Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length).", "$ref": "AllocationOptions" }, "migration": { "description": "Optional. Must be present if usage is set to FOR_MIGRATION.", "$ref": "Migration" }, "ipCidrRange": { "description": "Optional. IP range that this internal range defines. NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly.", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Time when the internal range was updated.", "format": "google-datetime" }, "labels": { "description": "Optional. User-defined labels.", "additionalProperties": { "type": "string" }, "type": "object" }, "immutable": { "description": "Optional. Immutable ranges cannot have their fields modified, except for labels and description.", "type": "boolean" }, "targetCidrRange": { "type": "array", "description": "Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the [\"10.0.0.0/8\", \"172.16.0.0/12\", \"192.168.0.0/16\"] address space (for auto-mode networks, the \"10.0.0.0/9\" range is used instead of \"10.0.0.0/8\"). This can be used to target the search in other rfc-1918 address spaces like \"172.16.0.0/12\" and \"192.168.0.0/16\" or non-rfc-1918 address spaces used in the VPC.", "items": { "type": "string" } } }, "description": "The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it.", "type": "object" }, "Spoke": { "type": "object", "description": "A Spoke is an abstraction of a network attachment being attached to a Hub. A Spoke can be underlying a VPN tunnel, a VLAN (interconnect) attachment, a Router appliance, etc.", "id": "Spoke", "properties": { "hub": { "description": "The resource URL of the hub resource that the spoke is attached to", "type": "string" }, "linkedRouterApplianceInstances": { "type": "array", "description": "The URIs of linked Router appliance resources", "items": { "$ref": "RouterApplianceInstance" } }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "User-defined labels." }, "linkedInterconnectAttachments": { "description": "The URIs of linked interconnect attachment resources", "items": { "type": "string" }, "type": "array" }, "linkedVpnTunnels": { "type": "array", "description": "The URIs of linked VPN tunnel resources", "items": { "type": "string" } }, "uniqueId": { "description": "Output only. Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different unique_id.", "type": "string", "readOnly": true }, "description": { "description": "Short description of the spoke resource", "type": "string" }, "updateTime": { "description": "The time when the Spoke was updated.", "format": "google-datetime", "type": "string" }, "name": { "description": "Immutable. The name of a Spoke resource.", "type": "string" }, "state": { "enumDescriptions": [ "No state information available", "The resource's create operation is in progress", "The resource is active", "The resource's Delete operation is in progress", "The resource's Update operation is in progress", "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "description": "Output only. The current lifecycle state of this Hub.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED" ], "readOnly": true }, "createTime": { "type": "string", "description": "The time when the Spoke was created.", "format": "google-datetime" } } }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "GoogleLongrunningOperation" }, "type": "array" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "type": "object" }, "GoogleRpcStatus": { "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).", "id": "GoogleRpcStatus", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "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" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "type": "array" } }, "type": "object" }, "Empty": { "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": "Empty", "properties": {}, "type": "object" }, "AuditLogConfig": { "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "id": "AuditLogConfig", "properties": { "logType": { "type": "string", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "description": "The log type that this config enables.", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ] }, "exemptedMembers": { "type": "array", "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" } } }, "type": "object" }, "TestIamPermissionsResponse": { "description": "Response message for `TestIamPermissions` method.", "id": "TestIamPermissionsResponse", "properties": { "permissions": { "type": "array", "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { "type": "string" } } }, "type": "object" }, "ListLocationsResponse": { "type": "object", "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" }, "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "ListHubsResponse": { "description": "Response for HubService.ListHubs method.", "id": "ListHubsResponse", "properties": { "nextPageToken": { "description": "The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.", "type": "string" }, "hubs": { "type": "array", "description": "Hubs to be returned.", "items": { "$ref": "Hub" } }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } } }, "type": "object" }, "ListInternalRangesResponse": { "description": "Response for InternalRange.ListInternalRanges", "id": "ListInternalRangesResponse", "properties": { "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "internalRanges": { "description": "Internal range to be returned.", "items": { "$ref": "InternalRange" }, "type": "array" }, "nextPageToken": { "description": "The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.", "type": "string" } }, "type": "object" }, "Migration": { "type": "object", "description": "Specification for migration with source and target resource names.", "id": "Migration", "properties": { "source": { "description": "Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}", "type": "string" }, "target": { "description": "Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. For example: /projects/{project}/regions/{region}/subnetworks/{subnet}", "type": "string" } } } }, "documentationLink": "https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest", "fullyEncodeReservedExpansion": true, "basePath": "", "canonicalName": "networkconnectivity", "batchPath": "batch", "name": "networkconnectivity", "revision": "20260409", "auth": { "oauth2": { "scopes": { "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." } } } }, "protocol": "rest", "ownerName": "Google", "kind": "discovery#restDescription", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "version": "v1alpha1", "mtlsRootUrl": "https://networkconnectivity.mtls.googleapis.com/", "parameters": { "alt": { "type": "string", "enum": [ "json", "media", "proto" ], "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "default": "json" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "quotaUser": { "type": "string", "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.", "location": "query" }, "key": { "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.", "location": "query", "type": "string" }, "prettyPrint": { "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query" }, "$.xgafv": { "location": "query", "type": "string", "enum": [ "1", "2" ], "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ] } }, "version_module": true, "resources": { "projects": { "resources": { "locations": { "methods": { "get": { "response": { "$ref": "Location" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Resource name for the location.", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}", "description": "Gets information about a location.", "path": "v1alpha1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "path": "v1alpha1/{+name}/locations", "id": "networkconnectivity.projects.locations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations", "parameters": { "pageToken": { "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query" }, "extraLocationTypes": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "name": { "required": true, "pattern": "^projects/[^/]+$", "location": "path", "type": "string", "description": "The resource that owns the locations collection, if applicable." }, "pageSize": { "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "format": "int32" } } } }, "resources": { "operations": { "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations", "parameters": { "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation's parent resource." }, "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "networkconnectivity.projects.locations.operations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1alpha1/{+name}/operations" }, "delete": { "response": { "$ref": "Empty" }, "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1alpha1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "response": { "$ref": "Empty" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "id": "networkconnectivity.projects.locations.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource.", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." } } }, "global": { "resources": { "hubs": { "methods": { "patch": { "parameters": { "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the Hub resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "location": "path", "required": true, "description": "Immutable. The name of a Hub resource.", "type": "string" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/global/hubs/{hubsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "request": { "$ref": "Hub" }, "id": "networkconnectivity.projects.locations.global.hubs.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Updates the description and/or labels of a Network Connectivity Center hub." }, "getIamPolicy": { "response": { "$ref": "Policy" }, "parameters": { "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "location": "path" }, "options.requestedPolicyVersion": { "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "format": "int32" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/global/hubs/{hubsId}:getIamPolicy", "path": "v1alpha1/{+resource}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "parameterOrder": [ "resource" ], "id": "networkconnectivity.projects.locations.global.hubs.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "pageSize": { "description": "The maximum number of results per page that should be returned.", "location": "query", "format": "int32", "type": "integer" }, "filter": { "type": "string", "description": "A filter expression that filters the results listed in the response.", "location": "query" }, "pageToken": { "type": "string", "description": "The page token.", "location": "query" }, "orderBy": { "type": "string", "description": "Sort the results by a certain order.", "location": "query" }, "parent": { "type": "string", "description": "Required. The parent resource's name.", "required": true, "pattern": "^projects/[^/]+/locations/global$", "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/global/hubs", "response": { "$ref": "ListHubsResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "networkconnectivity.projects.locations.global.hubs.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the Network Connectivity Center hubs associated with a given project.", "path": "v1alpha1/{+parent}/hubs" }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/global/hubs/{hubsId}", "parameters": { "name": { "type": "string", "description": "Required. The name of the Hub to delete.", "required": true, "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "location": "path" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "networkconnectivity.projects.locations.global.hubs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a Network Connectivity Center hub.", "path": "v1alpha1/{+name}" }, "setIamPolicy": { "response": { "$ref": "Policy" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/global/hubs/{hubsId}:setIamPolicy", "parameters": { "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "location": "path" } }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1alpha1/{+resource}:setIamPolicy", "id": "networkconnectivity.projects.locations.global.hubs.setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "resource" ], "request": { "$ref": "SetIamPolicyRequest" } }, "testIamPermissions": { "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/global/hubs/{hubsId}:testIamPermissions", "response": { "$ref": "TestIamPermissionsResponse" }, "httpMethod": "POST", "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" }, "id": "networkconnectivity.projects.locations.global.hubs.testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+resource}:testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning." }, "get": { "parameters": { "name": { "type": "string", "description": "Required. Name of the Hub resource to get.", "required": true, "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/global/hubs/{hubsId}", "response": { "$ref": "Hub" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.global.hubs.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Gets details about a Network Connectivity Center hub." }, "create": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "Hub" }, "id": "networkconnectivity.projects.locations.global.hubs.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/hubs", "description": "Creates a new Network Connectivity Center hub in the specified project.", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/global$", "location": "path", "type": "string", "description": "Required. The parent resource's name of the Hub." }, "hubId": { "description": "Optional. Unique id for the Hub to create.", "location": "query", "type": "string" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/global/hubs", "response": { "$ref": "GoogleLongrunningOperation" } } } } } }, "internalRanges": { "methods": { "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges", "parameters": { "orderBy": { "type": "string", "description": "Sort the results by a certain order.", "location": "query" }, "pageToken": { "description": "The page token.", "location": "query", "type": "string" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent resource's name." }, "pageSize": { "description": "The maximum number of results per page that should be returned.", "location": "query", "format": "int32", "type": "integer" }, "filter": { "type": "string", "description": "A filter expression that filters the results listed in the response.", "location": "query" } }, "response": { "$ref": "ListInternalRangesResponse" }, "id": "networkconnectivity.projects.locations.internalRanges.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/internalRanges", "description": "Lists internal ranges in a given project and location." }, "delete": { "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the InternalRange to delete." }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.internalRanges.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "description": "Deletes a single internal range." }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1alpha1/{+resource}:setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "request": { "$ref": "SetIamPolicyRequest" }, "id": "networkconnectivity.projects.locations.internalRanges.setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Policy" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:setIamPolicy" }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "path": "v1alpha1/{+resource}:testIamPermissions", "httpMethod": "POST", "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" }, "id": "networkconnectivity.projects.locations.internalRanges.testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "TestIamPermissionsResponse" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:testIamPermissions" }, "get": { "path": "v1alpha1/{+name}", "description": "Gets details of a single internal range.", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.internalRanges.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "InternalRange" }, "parameters": { "name": { "description": "Required. Name of the InternalRange to get.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}" }, "create": { "path": "v1alpha1/{+parent}/internalRanges", "description": "Creates a new internal range in a given project and location.", "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "InternalRange" }, "id": "networkconnectivity.projects.locations.internalRanges.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "parent": { "type": "string", "description": "Required. The parent resource's name of the InternalRange.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "internalRangeId": { "type": "string", "description": "Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.", "location": "query" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges" }, "patch": { "httpMethod": "PATCH", "parameterOrder": [ "name" ], "request": { "$ref": "InternalRange" }, "id": "networkconnectivity.projects.locations.internalRanges.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single internal range.", "path": "v1alpha1/{+name}", "parameters": { "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the internal range resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "location": "path", "required": true, "description": "Identifier. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}", "response": { "$ref": "GoogleLongrunningOperation" } }, "getIamPolicy": { "id": "networkconnectivity.projects.locations.internalRanges.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "resource" ], "path": "v1alpha1/{+resource}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:getIamPolicy", "parameters": { "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", "location": "path" }, "options.requestedPolicyVersion": { "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "format": "int32" } }, "response": { "$ref": "Policy" } } } }, "spokes": { "methods": { "get": { "path": "v1alpha1/{+name}", "description": "Gets details about a Network Connectivity Center spoke.", "id": "networkconnectivity.projects.locations.spokes.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "Spoke" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of Spoke resource." } } }, "create": { "path": "v1alpha1/{+parent}/spokes", "description": "Creates a Network Connectivity Center spoke.", "id": "networkconnectivity.projects.locations.spokes.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "Spoke" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/spokes", "parameters": { "parent": { "type": "string", "description": "Required. The parent's resource name of the Spoke.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "spokeId": { "description": "Optional. Unique id for the Spoke to create.", "location": "query", "type": "string" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } } }, "list": { "parameters": { "parent": { "type": "string", "description": "Required. The parent's resource name.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageToken": { "description": "The page token.", "location": "query", "type": "string" }, "orderBy": { "description": "Sort the results by a certain order.", "location": "query", "type": "string" }, "filter": { "description": "A filter expression that filters the results listed in the response.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "description": "The maximum number of results per page that should be returned.", "location": "query", "format": "int32" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/spokes", "response": { "$ref": "ListSpokesResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "networkconnectivity.projects.locations.spokes.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+parent}/spokes", "description": "Lists the Network Connectivity Center spokes in a specified project and location." }, "delete": { "parameters": { "name": { "description": "Required. The name of the Spoke to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", "location": "path", "required": true }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "networkconnectivity.projects.locations.spokes.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Network Connectivity Center spoke.", "path": "v1alpha1/{+name}" }, "setIamPolicy": { "httpMethod": "POST", "parameterOrder": [ "resource" ], "request": { "$ref": "SetIamPolicyRequest" }, "id": "networkconnectivity.projects.locations.spokes.setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+resource}:setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:setIamPolicy", "response": { "$ref": "Policy" } }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "path": "v1alpha1/{+resource}:testIamPermissions", "id": "networkconnectivity.projects.locations.spokes.testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" }, "response": { "$ref": "TestIamPermissionsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } } }, "patch": { "path": "v1alpha1/{+name}", "description": "Updates the parameters of a Network Connectivity Center spoke.", "id": "networkconnectivity.projects.locations.spokes.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameterOrder": [ "name" ], "request": { "$ref": "Spoke" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}", "parameters": { "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the Spoke resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "description": "Immutable. The name of a Spoke resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", "location": "path", "required": true }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } } }, "getIamPolicy": { "id": "networkconnectivity.projects.locations.spokes.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "resource" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1alpha1/{+resource}:getIamPolicy", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:getIamPolicy", "parameters": { "resource": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", "location": "path", "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." }, "options.requestedPolicyVersion": { "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "format": "int32" } }, "response": { "$ref": "Policy" } } } } } } } } }, "ownerDomain": "google.com", "servicePath": "", "baseUrl": "https://networkconnectivity.googleapis.com/", "discoveryVersion": "v1", "description": "This API enables connectivity with and between Google Cloud resources.", "title": "Network Connectivity API", "rootUrl": "https://networkconnectivity.googleapis.com/" }