API for managing HashiCorp virtual networks.
CreateDNSForwarding
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {dns_forwarding.hvn.location.organization_id}/ projects/ {dns_forwarding.hvn.location.project_id}/ networks/ {dns_forwarding.hvn.id}/ dnsforwardings
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
CreateDNSForwardingRule
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {dns_forwarding_rule.hvn.location.organization_id}/ projects/ {dns_forwarding_rule.hvn.location.project_id}/ networks/ {dns_forwarding_rule.hvn.id}/ dnsforwardings/ {dns_forwarding_rule.dns_forwarding_id}/ rules
organization_id is the id of the organization.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
ListDNSForwardings
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ dnsforwardings
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
ListDNSForwardingRules
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ dnsforwardings/ {dns_forwarding_id}/ rules
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
GetDNSForwardingRule
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ dnsforwardings/ {dns_forwarding_id}/ rules/ {id}
DNSForwardingId is the slug ID of the dns forwarding to which the rule belongs
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
GetDNSForwarding
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ dnsforwardings/ {id}
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
ListHVNRoutes
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ routes
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.
target_id is an optional parameter that allows returning only routes that has a specific target Id.
target_type is an optional parameter that allows returning only routes that has a specific target Type.
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Specifies a page token to use to retrieve the previous page. Set this to
the previous_page_token
returned by previous list requests to get the
previous page of results. If set, next_page_token
must not be set.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
HVNRouteTarget is a wrapper around HVN Route target that allows us to add more types of targets in the future.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
CreateHVNRoute
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ routes
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
HVNRouteTarget is a wrapper around HVN Route target that allows us to add more types of targets in the future.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
HVNRouteTarget is a wrapper around HVN Route target that allows us to add more types of targets in the future.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
GetHVNRoute
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ routes/ {id}
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
HVNRouteTarget is a wrapper around HVN Route target that allows us to add more types of targets in the future.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
DeleteHVNRoute
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ routes/ {id}
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
ListTGWAttachments
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ transit-gateway-attachments
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.
States is an optional parameter to list only TGW Attachments in a certain states if not specified all TGW Attachments will be returned.
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
CreateTGWAttachment
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ transit-gateway-attachments
id is the user-set transit gateway attachment slug ID, optional for now, if not present we will use internal-id.
CreateTGWAttachmentRequestProviderData is the provider specific data to create a TGW attachment. It is to be distinguished from TGWAttachment.ProviderData despite having overlapping fields.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
GetTGWAttachment
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ transit-gateway-attachments/ {id}
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
DeleteTGWAttachment
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {hvn.location.organization_id}/ projects/ {hvn.location.project_id}/ networks/ {hvn.id}/ transit-gateway-attachments/ {id}
type is the unique type of the resource. Each service publishes a
unique set of types. The type value is recommended to be formatted
in "
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
List
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Network represents a single operation.
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Create
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {network.location.organization_id}/ projects/ {network.location.project_id}/ networks
Network represents a single operation.
Network represents a single operation.
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
AssociateHVNWithAWSRoute53PrivateHostedZone
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {hvn_id}/ aws-route53-private-hosted-zone-associations
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
DeleteDNSForwardingRule
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {hvn_id}/ dnsforwardings/ {dns_forwarding_id}/ rules/ {id}
DNSForwardingId is the ID of the dns forwarding to which the rule belongs
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
ListPeerings
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {hvn_id}/ peerings
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
NetworkTarget is a Peering.Target based on another HVN.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
use_remote_gateways affects whether the HVN should use the gateway of the peereed VNET. If the flag is set to true, and allowGatewayTransit on remote VNET is also true, the HVN will use gateways of remote virtual network for transit. Only one peering can have this flag set to true.
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
GetPeering
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {hvn_id}/ peerings/ {id}
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
NetworkTarget is a Peering.Target based on another HVN.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
use_remote_gateways affects whether the HVN should use the gateway of the peereed VNET. If the flag is set to true, and allowGatewayTransit on remote VNET is also true, the HVN will use gateways of remote virtual network for transit. Only one peering can have this flag set to true.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
DeletePeering
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {hvn_id}/ peerings/ {id}
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Get
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {id}
Network represents a single operation.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Delete
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {id}
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
ListDependencies
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {id}/ dependencies
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
CreateToken
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {location.organization_id}/ projects/ {location.project_id}/ networks/ {id}/ tokens
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
CreatePeering
https:/ / api.cloud.hashicorp.com/ network/ 2020-09-07/ organizations/ {peering.hvn.location.organization_id}/ projects/ {peering.hvn.location.project_id}/ networks/ {peering.hvn.id}/ peerings
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
NetworkTarget is a Peering.Target based on another HVN.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
use_remote_gateways affects whether the HVN should use the gateway of the peereed VNET. If the flag is set to true, and allowGatewayTransit on remote VNET is also true, the HVN will use gateways of remote virtual network for transit. Only one peering can have this flag set to true.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
NetworkTarget is a Peering.Target based on another HVN.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
use_remote_gateways affects whether the HVN should use the gateway of the peereed VNET. If the flag is set to true, and allowGatewayTransit on remote VNET is also true, the HVN will use gateways of remote virtual network for transit. Only one peering can have this flag set to true.
Operation represents a single operation.
State is one of the states that an Operation can be in.
The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.
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. 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.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".
An arbitrary serialized message. Visit the protobufAny documentation for more information.
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
https
is assumed.Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.