# frozen_string_literal: true # Copyright 2022 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! module Google module Cloud module VmwareEngine module V1 # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_private_clouds VmwareEngine.ListPrivateClouds} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the private cloud to be queried for # clusters. Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of private clouds to return in one page. # The service may return fewer than this value. # The maximum value is coerced to 1000. # The default value of this field is 500. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListPrivateClouds` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListPrivateClouds` must # match the call that provided the page token. # @!attribute [rw] filter # @return [::String] # A filter expression that matches resources returned in the response. # The expression must specify the field name, a comparison operator, and the # value that you want to use for filtering. The value must be a string, a # number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or # `<`. # # For example, if you are filtering a list of private clouds, you can exclude # the ones named `example-pc` by specifying `name != "example-pc"`. # # You can also filter nested fields. For example, you could specify # `networkConfig.managementCidr = "192.168.0.0/24"` to include private clouds # only if they have a matching address in their network configuration. # # To filter on multiple expressions, provide each separate expression within # parentheses. For example: # ``` # (name = "example-pc") # (createTime > "2021-04-12T08:15:10.40Z") # ``` # # By default, each expression is an `AND` expression. However, you can # include `AND` and `OR` expressions explicitly. For example: # ``` # (name = "private-cloud-1") AND # (createTime > "2021-04-12T08:15:10.40Z") OR # (name = "private-cloud-2") # ``` # @!attribute [rw] order_by # @return [::String] # Sorts list results by a certain order. By default, returned results are # ordered by `name` in ascending order. You can also sort results in # descending order based on the `name` value using `orderBy="name desc"`. # Currently, only ordering by `name` is supported. class ListPrivateCloudsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_private_clouds VmwareEngine.ListPrivateClouds} # @!attribute [rw] private_clouds # @return [::Array<::Google::Cloud::VmwareEngine::V1::PrivateCloud>] # A list of private clouds. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. # @!attribute [rw] unreachable # @return [::Array<::String>] # Locations that could not be reached when making an aggregated query using # wildcards. class ListPrivateCloudsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#get_private_cloud VmwareEngine.GetPrivateCloud} # @!attribute [rw] name # @return [::String] # Required. The resource name of the private cloud to retrieve. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` class GetPrivateCloudRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#create_private_cloud VmwareEngine.CreatePrivateCloud} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the location to create the new # private cloud in. Resource names are schemeless URIs that follow the # conventions in https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a` # @!attribute [rw] private_cloud_id # @return [::String] # Required. The user-provided identifier of the private cloud to be created. # This identifier must be unique among each `PrivateCloud` within the parent # and becomes the final token in the name URI. # The identifier must meet the following requirements: # # * Only contains 1-63 alphanumeric characters and hyphens # * Begins with an alphabetical character # * Ends with a non-hyphen character # * Not formatted as a UUID # * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) # (section 3.5) # @!attribute [rw] private_cloud # @return [::Google::Cloud::VmwareEngine::V1::PrivateCloud] # Required. The initial description of the new private cloud. # @!attribute [rw] request_id # @return [::String] # Optional. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @!attribute [rw] validate_only # @return [::Boolean] # Optional. True if you want the request to be validated and not executed; # false otherwise. class CreatePrivateCloudRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#update_private_cloud VmwareEngine.UpdatePrivateCloud} # @!attribute [rw] private_cloud # @return [::Google::Cloud::VmwareEngine::V1::PrivateCloud] # Required. Private cloud description. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. Field mask is used to specify the fields to be overwritten in the # `PrivateCloud` resource by the update. The fields specified in `updateMask` # 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. # @!attribute [rw] request_id # @return [::String] # Optional. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). class UpdatePrivateCloudRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#delete_private_cloud VmwareEngine.DeletePrivateCloud} # @!attribute [rw] name # @return [::String] # Required. The resource name of the private cloud to delete. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` # @!attribute [rw] request_id # @return [::String] # Optional. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @!attribute [rw] force # @return [::Boolean] # Optional. If set to true, cascade delete is enabled and all children of # this private cloud resource are also deleted. When this flag is set to # false, the private cloud will not be deleted if there are any children # other than the management cluster. The management cluster is always # deleted. # @!attribute [rw] delay_hours # @return [::Integer] # Optional. Time delay of the deletion specified in hours. The default value # is `3`. Specifying a non-zero value for this field changes the value of # `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned # deletion time. Deletion can be cancelled before `expire_time` elapses using # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#undelete_private_cloud VmwareEngine.UndeletePrivateCloud}. # Specifying a value of `0` for this field instead begins the deletion # process and ceases billing immediately. During the final deletion process, # the value of `PrivateCloud.state` becomes `PURGING`. class DeletePrivateCloudRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#undelete_private_cloud VmwareEngine.UndeletePrivateCloud} # @!attribute [rw] name # @return [::String] # Required. The resource name of the private cloud scheduled for deletion. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` # @!attribute [rw] request_id # @return [::String] # Optional. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). class UndeletePrivateCloudRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_clusters VmwareEngine.ListClusters} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the private cloud to query for clusters. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of clusters to return in one page. # The service may return fewer than this value. # The maximum value is coerced to 1000. # The default value of this field is 500. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListClusters` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListClusters` # must match the call that provided the page token. # @!attribute [rw] filter # @return [::String] # To filter on multiple expressions, provide each separate expression within # parentheses. For example: # ``` # (name = "example-cluster") # (nodeCount = "3") # ``` # # By default, each expression is an `AND` expression. However, you can # include `AND` and `OR` expressions explicitly. For example: # ``` # (name = "example-cluster-1") AND # (createTime > "2021-04-12T08:15:10.40Z") OR # (name = "example-cluster-2") # ``` # @!attribute [rw] order_by # @return [::String] # Sorts list results by a certain order. By default, returned results are # ordered by `name` in ascending order. You can also sort results in # descending order based on the `name` value using `orderBy="name desc"`. # Currently, only ordering by `name` is supported. class ListClustersRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_clusters VmwareEngine.ListClusters} # @!attribute [rw] clusters # @return [::Array<::Google::Cloud::VmwareEngine::V1::Cluster>] # A list of private cloud clusters. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. # @!attribute [rw] unreachable # @return [::Array<::String>] # Locations that could not be reached when making an aggregated query using # wildcards. class ListClustersResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#get_cluster VmwareEngine.GetCluster} # @!attribute [rw] name # @return [::String] # Required. The cluster resource name to retrieve. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` class GetClusterRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#create_cluster VmwareEngine.CreateCluster} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the private cloud to create a new cluster # in. Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` # @!attribute [rw] cluster_id # @return [::String] # Required. The user-provided identifier of the new `Cluster`. # This identifier must be unique among clusters within the parent and becomes # the final token in the name URI. # The identifier must meet the following requirements: # # * Only contains 1-63 alphanumeric characters and hyphens # * Begins with an alphabetical character # * Ends with a non-hyphen character # * Not formatted as a UUID # * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) # (section 3.5) # @!attribute [rw] cluster # @return [::Google::Cloud::VmwareEngine::V1::Cluster] # Required. The initial description of the new cluster. # @!attribute [rw] request_id # @return [::String] # Optional. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @!attribute [rw] validate_only # @return [::Boolean] # Optional. True if you want the request to be validated and not executed; # false otherwise. class CreateClusterRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#update_cluster VmwareEngine.UpdateCluster} # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. Field mask is used to specify the fields to be overwritten in the # `Cluster` resource by the update. The fields specified in the `updateMask` # 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. # @!attribute [rw] cluster # @return [::Google::Cloud::VmwareEngine::V1::Cluster] # Required. The description of the cluster. # @!attribute [rw] request_id # @return [::String] # Optional. The request ID must be a valid UUID with the exception that # zero UUID is not supported (00000000-0000-0000-0000-000000000000). # @!attribute [rw] validate_only # @return [::Boolean] # Optional. True if you want the request to be validated and not executed; # false otherwise. class UpdateClusterRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#delete_cluster VmwareEngine.DeleteCluster} # @!attribute [rw] name # @return [::String] # Required. The resource name of the cluster to delete. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` # @!attribute [rw] request_id # @return [::String] # Optional. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). class DeleteClusterRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_subnets VmwareEngine.ListSubnets} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the private cloud to be queried for # subnets. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of subnets to return in one page. # The service may return fewer than this value. # The maximum value is coerced to 1000. # The default value of this field is 500. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListSubnetsRequest` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListSubnetsRequest` must match the call that provided the page token. class ListSubnetsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_subnets VmwareEngine.ListSubnets} # @!attribute [rw] subnets # @return [::Array<::Google::Cloud::VmwareEngine::V1::Subnet>] # A list of subnets. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. class ListSubnetsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents the metadata of the long-running operation. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time the operation was created. # @!attribute [r] end_time # @return [::Google::Protobuf::Timestamp] # Output only. The time the operation finished running. # @!attribute [r] target # @return [::String] # Output only. Server-defined resource path for the target of the operation. # @!attribute [r] verb # @return [::String] # Output only. Name of the verb executed by the operation. # @!attribute [r] status_message # @return [::String] # Output only. Human-readable status of the operation, if any. # @!attribute [r] requested_cancellation # @return [::Boolean] # Output only. True if the user has requested cancellation # of the operation; false otherwise. # Operations that have successfully been cancelled # have [Operation.error][] value with a # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to # `Code.CANCELLED`. # @!attribute [r] api_version # @return [::String] # Output only. API version used to start the operation. class OperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_node_types VmwareEngine.ListNodeTypes} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the location to be queried for node types. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of node types to return in one page. # The service may return fewer than this value. # The maximum value is coerced to 1000. # The default value of this field is 500. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListNodeTypes` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListNodeTypes` must match the call that provided the page token. # @!attribute [rw] filter # @return [::String] # A filter expression that matches resources returned in the response. # The expression must specify the field name, a comparison # operator, and the value that you want to use for filtering. The value # must be a string, a number, or a boolean. The comparison operator # must be `=`, `!=`, `>`, or `<`. # # For example, if you are filtering a list of node types, you can # exclude the ones named `standard-72` by specifying # `name != "standard-72"`. # # To filter on multiple expressions, provide each separate expression within # parentheses. For example: # ``` # (name = "standard-72") # (virtual_cpu_count > 2) # ``` # # By default, each expression is an `AND` expression. However, you # can include `AND` and `OR` expressions explicitly. # For example: # ``` # (name = "standard-96") AND # (virtual_cpu_count > 2) OR # (name = "standard-72") # ``` class ListNodeTypesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_node_types VmwareEngine.ListNodeTypes} # @!attribute [rw] node_types # @return [::Array<::Google::Cloud::VmwareEngine::V1::NodeType>] # A list of Node Types. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. # @!attribute [rw] unreachable # @return [::Array<::String>] # Locations that could not be reached when making an aggregated query using # wildcards. class ListNodeTypesResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#get_node_type VmwareEngine.GetNodeType} # @!attribute [rw] name # @return [::String] # Required. The resource name of the node type to retrieve. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-proj/locations/us-central1-a/nodeTypes/standard-72` class GetNodeTypeRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#show_nsx_credentials VmwareEngine.ShowNsxCredentials} # @!attribute [rw] private_cloud # @return [::String] # Required. The resource name of the private cloud # to be queried for credentials. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` class ShowNsxCredentialsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#show_vcenter_credentials VmwareEngine.ShowVcenterCredentials} # @!attribute [rw] private_cloud # @return [::String] # Required. The resource name of the private cloud # to be queried for credentials. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` class ShowVcenterCredentialsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#reset_nsx_credentials VmwareEngine.ResetNsxCredentials} # @!attribute [rw] private_cloud # @return [::String] # Required. The resource name of the private cloud # to reset credentials for. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` # @!attribute [rw] request_id # @return [::String] # 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). class ResetNsxCredentialsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#reset_vcenter_credentials VmwareEngine.ResetVcenterCredentials} # @!attribute [rw] private_cloud # @return [::String] # Required. The resource name of the private cloud # to reset credentials for. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` # @!attribute [rw] request_id # @return [::String] # 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). class ResetVcenterCredentialsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_hcx_activation_keys VmwareEngine.ListHcxActivationKeys} # @!attribute [rw] hcx_activation_keys # @return [::Array<::Google::Cloud::VmwareEngine::V1::HcxActivationKey>] # List of HCX activation keys. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. # @!attribute [rw] unreachable # @return [::Array<::String>] # Locations that could not be reached when making an aggregated query using # wildcards. class ListHcxActivationKeysResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_hcx_activation_keys VmwareEngine.ListHcxActivationKeys} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the private cloud # to be queried for HCX activation keys. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1/privateClouds/my-cloud` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of HCX activation keys to return in one page. # The service may return fewer than this value. # The maximum value is coerced to 1000. # The default value of this field is 500. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListHcxActivationKeys` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListHcxActivationKeys` must match the call that provided the page # token. class ListHcxActivationKeysRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for [VmwareEngine.GetHcxActivationKeys][] # @!attribute [rw] name # @return [::String] # Required. The resource name of the HCX activation key to retrieve. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key` class GetHcxActivationKeyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#create_hcx_activation_key VmwareEngine.CreateHcxActivationKey} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the private cloud to create the key for. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1/privateClouds/my-cloud` # @!attribute [rw] hcx_activation_key # @return [::Google::Cloud::VmwareEngine::V1::HcxActivationKey] # Required. The initial description of a new HCX activation key. When # creating a new key, this field must be an empty object. # @!attribute [rw] hcx_activation_key_id # @return [::String] # Required. The user-provided identifier of the `HcxActivationKey` to be # created. This identifier must be unique among `HcxActivationKey` resources # within the parent and becomes the final token in the name URI. # The identifier must meet the following requirements: # # * Only contains 1-63 alphanumeric characters and hyphens # * Begins with an alphabetical character # * Ends with a non-hyphen character # * Not formatted as a UUID # * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) # (section 3.5) # @!attribute [rw] request_id # @return [::String] # 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). class CreateHcxActivationKeyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_network_policies VmwareEngine.ListNetworkPolicies} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the location (region) to query for # network policies. Resource names are schemeless URIs that follow the # conventions in https://cloud.google.com/apis/design/resource_names. For # example: `projects/my-project/locations/us-central1` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of network policies to return in one page. # The service may return fewer than this value. # The maximum value is coerced to 1000. # The default value of this field is 500. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListNetworkPolicies` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListNetworkPolicies` must match the call that provided the page # token. # @!attribute [rw] filter # @return [::String] # A filter expression that matches resources returned in the response. # The expression must specify the field name, a comparison # operator, and the value that you want to use for filtering. The value # must be a string, a number, or a boolean. The comparison operator # must be `=`, `!=`, `>`, or `<`. # # For example, if you are filtering a list of network policies, you can # exclude the ones named `example-policy` by specifying # `name != "example-policy"`. # # To filter on multiple expressions, provide each separate expression within # parentheses. For example: # ``` # (name = "example-policy") # (createTime > "2021-04-12T08:15:10.40Z") # ``` # # By default, each expression is an `AND` expression. However, you # can include `AND` and `OR` expressions explicitly. # For example: # ``` # (name = "example-policy-1") AND # (createTime > "2021-04-12T08:15:10.40Z") OR # (name = "example-policy-2") # ``` # @!attribute [rw] order_by # @return [::String] # Sorts list results by a certain order. By default, returned results # are ordered by `name` in ascending order. # You can also sort results in descending order based on the `name` value # using `orderBy="name desc"`. # Currently, only ordering by `name` is supported. class ListNetworkPoliciesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_network_policies VmwareEngine.ListNetworkPolicies} # @!attribute [rw] network_policies # @return [::Array<::Google::Cloud::VmwareEngine::V1::NetworkPolicy>] # A list of network policies. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be send as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. # @!attribute [rw] unreachable # @return [::Array<::String>] # Locations that could not be reached when making an aggregated query using # wildcards. class ListNetworkPoliciesResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#get_network_policy VmwareEngine.GetNetworkPolicy} # @!attribute [rw] name # @return [::String] # Required. The resource name of the network policy to retrieve. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` class GetNetworkPolicyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#update_network_policy VmwareEngine.UpdateNetworkPolicy} # @!attribute [rw] network_policy # @return [::Google::Cloud::VmwareEngine::V1::NetworkPolicy] # Required. Network policy description. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. Field mask is used to specify the fields to be overwritten in the # `NetworkPolicy` 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. # @!attribute [rw] request_id # @return [::String] # 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). class UpdateNetworkPolicyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#create_network_policy VmwareEngine.CreateNetworkPolicy} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the location (region) # to create the new network policy in. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1` # @!attribute [rw] network_policy_id # @return [::String] # Required. The user-provided identifier of the network policy to be created. # This identifier must be unique within parent # `projects/{my-project}/locations/{us-central1}/networkPolicies` and becomes # the final token in the name URI. # The identifier must meet the following requirements: # # * Only contains 1-63 alphanumeric characters and hyphens # * Begins with an alphabetical character # * Ends with a non-hyphen character # * Not formatted as a UUID # * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) # (section 3.5) # @!attribute [rw] network_policy # @return [::Google::Cloud::VmwareEngine::V1::NetworkPolicy] # Required. The network policy configuration to use in the request. # @!attribute [rw] request_id # @return [::String] # 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). class CreateNetworkPolicyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#delete_network_policy VmwareEngine.DeleteNetworkPolicy} # @!attribute [rw] name # @return [::String] # Required. The resource name of the network policy to delete. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` # @!attribute [rw] request_id # @return [::String] # 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). class DeleteNetworkPolicyRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#create_vmware_engine_network VmwareEngine.CreateVmwareEngineNetwork} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the location to create the new VMware Engine # network in. A VMware Engine network of type # `LEGACY` is a regional resource, and a VMware # Engine network of type `STANDARD` is a global resource. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. For example: # `projects/my-project/locations/global` # @!attribute [rw] vmware_engine_network_id # @return [::String] # Required. The user-provided identifier of the new VMware Engine network. # This identifier must be unique among VMware Engine network resources # within the parent and becomes the final token in the name URI. The # identifier must meet the following requirements: # # * For networks of type LEGACY, adheres to the format: # `{region-id}-default`. Replace `{region-id}` with the region where you want # to create the VMware Engine network. For example, "us-central1-default". # * Only contains 1-63 alphanumeric characters and hyphens # * Begins with an alphabetical character # * Ends with a non-hyphen character # * Not formatted as a UUID # * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) # (section 3.5) # @!attribute [rw] vmware_engine_network # @return [::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork] # Required. The initial description of the new VMware Engine network. # @!attribute [rw] request_id # @return [::String] # 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). class CreateVmwareEngineNetworkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#update_vmware_engine_network VmwareEngine.UpdateVmwareEngineNetwork} # @!attribute [rw] vmware_engine_network # @return [::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork] # Required. VMware Engine network description. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. Field mask is used to specify the fields to be overwritten in the # VMware Engine network 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. Only the # following fields can be updated: `description`. # @!attribute [rw] request_id # @return [::String] # 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). class UpdateVmwareEngineNetworkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#delete_vmware_engine_network VmwareEngine.DeleteVmwareEngineNetwork} # @!attribute [rw] name # @return [::String] # Required. The resource name of the VMware Engine network to be deleted. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/global/vmwareEngineNetworks/my-network` # @!attribute [rw] request_id # @return [::String] # 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). # @!attribute [rw] etag # @return [::String] # Optional. Checksum used to ensure that the user-provided value is up to # date before the server processes the request. The server compares provided # checksum with the current checksum of the resource. If the user-provided # value is out of date, this request returns an `ABORTED` error. class DeleteVmwareEngineNetworkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#get_vmware_engine_network VmwareEngine.GetVmwareEngineNetwork} # @!attribute [rw] name # @return [::String] # Required. The resource name of the VMware Engine network to retrieve. # Resource names are schemeless URIs that follow the conventions in # https://cloud.google.com/apis/design/resource_names. # For example: # `projects/my-project/locations/global/vmwareEngineNetworks/my-network` class GetVmwareEngineNetworkRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_vmware_engine_networks VmwareEngine.ListVmwareEngineNetworks} # @!attribute [rw] parent # @return [::String] # Required. The resource name of the location to query for # VMware Engine networks. Resource names are schemeless URIs that follow the # conventions in https://cloud.google.com/apis/design/resource_names. For # example: `projects/my-project/locations/global` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of results to return in one page. # The maximum value is coerced to 1000. # The default value of this field is 500. # @!attribute [rw] page_token # @return [::String] # A page token, received from a previous `ListVmwareEngineNetworks` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListVmwareEngineNetworks` must match the call that provided the page # token. # @!attribute [rw] filter # @return [::String] # A filter expression that matches resources returned in the response. # The expression must specify the field name, a comparison # operator, and the value that you want to use for filtering. The value # must be a string, a number, or a boolean. The comparison operator # must be `=`, `!=`, `>`, or `<`. # # For example, if you are filtering a list of network peerings, you can # exclude the ones named `example-network` by specifying # `name != "example-network"`. # # To filter on multiple expressions, provide each separate expression within # parentheses. For example: # ``` # (name = "example-network") # (createTime > "2021-04-12T08:15:10.40Z") # ``` # # By default, each expression is an `AND` expression. However, you # can include `AND` and `OR` expressions explicitly. # For example: # ``` # (name = "example-network-1") AND # (createTime > "2021-04-12T08:15:10.40Z") OR # (name = "example-network-2") # ``` # @!attribute [rw] order_by # @return [::String] # Sorts list results by a certain order. By default, returned results # are ordered by `name` in ascending order. # You can also sort results in descending order based on the `name` value # using `orderBy="name desc"`. # Currently, only ordering by `name` is supported. class ListVmwareEngineNetworksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::VmwareEngine::V1::VmwareEngine::Client#list_vmware_engine_networks VmwareEngine.ListVmwareEngineNetworks} # @!attribute [rw] vmware_engine_networks # @return [::Array<::Google::Cloud::VmwareEngine::V1::VmwareEngineNetwork>] # A list of VMware Engine networks. # @!attribute [rw] next_page_token # @return [::String] # A token, which can be sent as `page_token` to retrieve the next page. # If this field is omitted, there are no subsequent pages. # @!attribute [rw] unreachable # @return [::Array<::String>] # Unreachable resources. class ListVmwareEngineNetworksResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end