Class: Google::Apis::CloudnumberregistryV1alpha::SearchIpResourcesRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudnumberregistry_v1alpha/classes.rb,
lib/google/apis/cloudnumberregistry_v1alpha/representations.rb,
lib/google/apis/cloudnumberregistry_v1alpha/representations.rb

Overview

Message for searching IP resources

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchIpResourcesRequest

Returns a new instance of SearchIpResourcesRequest.



1210
1211
1212
 
# File 'lib/google/apis/cloudnumberregistry_v1alpha/classes.rb', line 1210

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#order_by ⇒ String

Optional. Hint for how to order the results Corresponds to the JSON property orderBy

Returns:

  • (String) 


1165
1166
1167
 
# File 'lib/google/apis/cloudnumberregistry_v1alpha/classes.rb', line 1165

def order_by
  @order_by
end

#page_size ⇒ Fixnum

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


1171
1172
1173
 
# File 'lib/google/apis/cloudnumberregistry_v1alpha/classes.rb', line 1171

def page_size
  @page_size
end

#page_token ⇒ String

Optional. A token identifying a page of results the server should return. Corresponds to the JSON property pageToken

Returns:

  • (String) 


1176
1177
1178
 
# File 'lib/google/apis/cloudnumberregistry_v1alpha/classes.rb', line 1176

def page_token
  @page_token
end

#query ⇒ String

Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for ranges are: - realm : The realm name to search in. - ip_address: The IP address to search for within ranges. - ip_version: The IP version to filter by (e.g., "IPV4", " IPV6"). - parent_range: The parent range of the range to search for. - attribute_text: The attribute text to search for within ranges. - attribute: The attribute key and value to filter by. The available restrictions for realms are: - ip_version: The IP version to search for. Only one of attribute_text or multiple attribute filters can be specified. Examples: - realm=test-realm - realm=test-realm AND ip_address=10.0.0.0 - realm=test- realm AND ip_version=IPV6 - realm=test-realm AND attribute_text=test - ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2) - attribute_text=test AND parent_range=projects/123/locations/global/ discoveredRanges/test-parent-range Corresponds to the JSON property query

Returns:

  • (String) 


1196
1197
1198
 
# File 'lib/google/apis/cloudnumberregistry_v1alpha/classes.rb', line 1196

def query
  @query
end

#search_resource_types ⇒ Array<String>

Optional. The type of resources to search for. If not specified, the server will return ranges. Corresponds to the JSON property searchResourceTypes

Returns:

  • (Array<String>) 


1202
1203
1204
 
# File 'lib/google/apis/cloudnumberregistry_v1alpha/classes.rb', line 1202

def search_resource_types
  @search_resource_types
end

#show_utilization ⇒ Boolean Also known as: show_utilization?

Optional. Whether to show the utilization of the ranges in the response. Corresponds to the JSON property showUtilization

Returns:

  • (Boolean) 


1207
1208
1209
 
# File 'lib/google/apis/cloudnumberregistry_v1alpha/classes.rb', line 1207

def show_utilization
  @show_utilization
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'lib/google/apis/cloudnumberregistry_v1alpha/classes.rb', line 1215

def update!(**args)
  @order_by = args[:order_by] if args.key?(:order_by)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @query = args[:query] if args.key?(:query)
  @search_resource_types = args[:search_resource_types] if args.key?(:search_resource_types)
  @show_utilization = args[:show_utilization] if args.key?(:show_utilization)
end