Class: Google::Apis::FileV1beta1::Instance

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

Overview

A Filestore instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



855
856
857
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 855

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

Instance Attribute Details

#capacity_gb ⇒ Fixnum

The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to max_capacity_gb GB in multipliers of capacity_step_size_gb GB. Corresponds to the JSON property capacityGb

Returns:

  • (Fixnum) 


752
753
754
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 752

def capacity_gb
  @capacity_gb
end

#capacity_step_size_gb ⇒ Fixnum

Output only. The increase/decrease capacity step size. Corresponds to the JSON property capacityStepSizeGb

Returns:

  • (Fixnum) 


757
758
759
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 757

def capacity_step_size_gb
  @capacity_step_size_gb
end

#create_time ⇒ String

Output only. The time when the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


762
763
764
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 762

def create_time
  @create_time
end

#description ⇒ String

The description of the instance (2048 characters or less). Corresponds to the JSON property description

Returns:

  • (String) 


767
768
769
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 767

def description
  @description
end

#etag ⇒ String

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. Corresponds to the JSON property etag

Returns:

  • (String) 


773
774
775
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 773

def etag
  @etag
end

#file_shares ⇒ Array<Google::Apis::FileV1beta1::FileShareConfig>

File system shares on the instance. For this version, only a single file share is supported. Corresponds to the JSON property fileShares

Returns:



779
780
781
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 779

def file_shares
  @file_shares
end

#kms_key_name ⇒ String

KMS key name used for data encryption. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


784
785
786
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 784

def kms_key_name
  @kms_key_name
end

#labels ⇒ Hash<String,String>

Resource labels to represent user provided metadata. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


789
790
791
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 789

def labels
  @labels
end

#max_capacity_gb ⇒ Fixnum

Output only. The max capacity of the instance. Corresponds to the JSON property maxCapacityGb

Returns:

  • (Fixnum) 


794
795
796
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 794

def max_capacity_gb
  @max_capacity_gb
end

#max_share_count ⇒ Fixnum

The max number of shares allowed. Corresponds to the JSON property maxShareCount

Returns:

  • (Fixnum) 


799
800
801
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 799

def max_share_count
  @max_share_count
end

#multi_share_enabled ⇒ Boolean Also known as: multi_share_enabled?

Indicates whether this instance uses a multi-share configuration with which it can have more than one file-share or none at all. File-shares are added, updated and removed through the separate file-share APIs. Corresponds to the JSON property multiShareEnabled

Returns:

  • (Boolean) 


806
807
808
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 806

def multi_share_enabled
  @multi_share_enabled
end

#name ⇒ String

Output only. The resource name of the instance, in the format projects/ project_id/locations/location_id/instances/instance_id`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


813
814
815
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 813

def name
  @name
end

#networks ⇒ Array<Google::Apis::FileV1beta1::NetworkConfig>

VPC networks to which the instance is connected. For this version, only a single network is supported. Corresponds to the JSON property networks

Returns:



819
820
821
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 819

def networks
  @networks
end

#protocol ⇒ String

Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3. Corresponds to the JSON property protocol

Returns:

  • (String) 


826
827
828
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 826

def protocol
  @protocol
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


831
832
833
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 831

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

Output only. The instance state. Corresponds to the JSON property state

Returns:

  • (String) 


837
838
839
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 837

def state
  @state
end

#status_message ⇒ String

Output only. Additional information about the instance state, if available. Corresponds to the JSON property statusMessage

Returns:

  • (String) 


842
843
844
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 842

def status_message
  @status_message
end

#suspension_reasons ⇒ Array<String>

Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. Corresponds to the JSON property suspensionReasons

Returns:

  • (Array<String>) 


848
849
850
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 848

def suspension_reasons
  @suspension_reasons
end

#tier ⇒ String

The service tier of the instance. Corresponds to the JSON property tier

Returns:

  • (String) 


853
854
855
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 853

def tier
  @tier
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
 
# File 'lib/google/apis/file_v1beta1/classes.rb', line 860

def update!(**args)
  @capacity_gb = args[:capacity_gb] if args.key?(:capacity_gb)
  @capacity_step_size_gb = args[:capacity_step_size_gb] if args.key?(:capacity_step_size_gb)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @file_shares = args[:file_shares] if args.key?(:file_shares)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @labels = args[:labels] if args.key?(:labels)
  @max_capacity_gb = args[:max_capacity_gb] if args.key?(:max_capacity_gb)
  @max_share_count = args[:max_share_count] if args.key?(:max_share_count)
  @multi_share_enabled = args[:multi_share_enabled] if args.key?(:multi_share_enabled)
  @name = args[:name] if args.key?(:name)
  @networks = args[:networks] if args.key?(:networks)
  @protocol = args[:protocol] if args.key?(:protocol)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @state = args[:state] if args.key?(:state)
  @status_message = args[:status_message] if args.key?(:status_message)
  @suspension_reasons = args[:suspension_reasons] if args.key?(:suspension_reasons)
  @tier = args[:tier] if args.key?(:tier)
end