Class: Google::Cloud::OsConfig::V1::OSPolicy::Resource

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/osconfig/v1/os_policy.rb

Overview

An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc.

The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.

Defined Under Namespace

Classes: ExecResource, File, FileResource, PackageResource, RepositoryResource

Instance Attribute Summary collapse

Instance Attribute Details

#exec ⇒ ::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource

Returns Exec resource.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy.rb', line 106

class Resource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A remote or local file.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Remote]
  #     A generic remote file.
  # @!attribute [rw] gcs
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Gcs]
  #     A Cloud Storage object.
  # @!attribute [rw] local_path
  #   @return [::String]
  #     A local path within the VM to use.
  # @!attribute [rw] allow_insecure
  #   @return [::Boolean]
  #     Defaults to false. When false, files are subject to validations
  #     based on the file type:
  #
  #     Remote: A checksum must be specified.
  #     Cloud Storage: An object generation number must be specified.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies a file available via some URI.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI from which to fetch the object. It should contain both
    #     the protocol and path following the format `{protocol}://{location}`.
    # @!attribute [rw] sha256_checksum
    #   @return [::String]
    #     SHA256 checksum of the remote file.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies a file available as a Cloud Storage Object.
    # @!attribute [rw] bucket
    #   @return [::String]
    #     Required. Bucket of the Cloud Storage object.
    # @!attribute [rw] object
    #   @return [::String]
    #     Required. Name of the Cloud Storage object.
    # @!attribute [rw] generation
    #   @return [::Integer]
    #     Generation number of the Cloud Storage object.
    class Gcs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that manages a system package.
  # @!attribute [rw] desired_state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::DesiredState]
  #     Required. The desired state the agent should maintain for this package.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::APT]
  #     A package managed by Apt.
  # @!attribute [rw] deb
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Deb]
  #     A deb package file.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::YUM]
  #     A package managed by YUM.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Zypper]
  #     A package managed by Zypper.
  # @!attribute [rw] rpm
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::RPM]
  #     An rpm package file.
  # @!attribute [rw] googet
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::GooGet]
  #     A package managed by GooGet.
  # @!attribute [rw] msi
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::MSI]
  #     An MSI package.
  class PackageResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A deb package file. dpkg packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. A deb package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `dpkg -i package`
    #     - install when true: `apt-get update && apt-get -y install
    #     package.deb`
    class Deb
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by APT.
    # - install: `apt-get update && apt-get -y install [name]`
    # - remove: `apt-get -y remove [name]`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class APT
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An RPM package file. RPM packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. An rpm package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `rpm --upgrade --replacepkgs package.rpm`
    #     - install when true: `yum -y install package.rpm` or
    #     `zypper -y install package.rpm`
    class RPM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by YUM.
    # - install: `yum -y install package`
    # - remove: `yum -y remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class YUM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by Zypper.
    # - install: `zypper -y install package`
    # - remove: `zypper -y rm package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class Zypper
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by GooGet.
    # - install: `googet -noconfirm install package`
    # - remove: `googet -noconfirm remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class GooGet
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An MSI package. MSI packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. The MSI package.
    # @!attribute [rw] properties
    #   @return [::Array<::String>]
    #     Additional properties to use during installation.
    #     This should be in the format of Property=Setting.
    #     Appended to the defaults of `ACTION=INSTALL
    #     REBOOT=ReallySuppress`.
    class MSI
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The desired state that the OS Config agent maintains on the VM.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure that the package is installed.
      INSTALLED = 1

      # The agent ensures that the package is not installed and
      # uninstalls it if detected.
      REMOVED = 2
    end
  end

  # A resource that manages a package repository.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository]
  #     An Apt Repository.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::YumRepository]
  #     A Yum Repository.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::ZypperRepository]
  #     A Zypper Repository.
  # @!attribute [rw] goo
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::GooRepository]
  #     A Goo Repository.
  class RepositoryResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents a single apt package repository. These will be added to
    # a repo file that will be managed at
    # `/etc/apt/sources.list.d/google_osconfig.list`.
    # @!attribute [rw] archive_type
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository::ArchiveType]
    #     Required. Type of archive files in this repository.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI for this repository.
    # @!attribute [rw] distribution
    #   @return [::String]
    #     Required. Distribution of this repository.
    # @!attribute [rw] components
    #   @return [::Array<::String>]
    #     Required. List of components for this repository. Must contain at
    #     least one item.
    # @!attribute [rw] gpg_key
    #   @return [::String]
    #     URI of the key file for this repository. The agent maintains a
    #     keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
    class AptRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Type of archive.
      module ArchiveType
        # Unspecified is invalid.
        ARCHIVE_TYPE_UNSPECIFIED = 0

        # Deb indicates that the archive contains binary files.
        DEB = 1

        # Deb-src indicates that the archive contains source files.
        DEB_SRC = 2
      end
    end

    # Represents a single yum package repository. These are added to a
    # repo file that is managed at
    # `/etc/yum.repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is  the
    #     `repo id` in the yum config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for resource conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class YumRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a single zypper package repository. These are added to a
    # repo file that is managed at
    # `/etc/zypp/repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is the
    #     `repo id` in the zypper config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for GuestPolicy conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class ZypperRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a Goo package repository. These are added to a repo file
    # that is managed at
    # `C:/ProgramData/GooGet/repos/google_osconfig.repo`.
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. The name of the repository.
    # @!attribute [rw] url
    #   @return [::String]
    #     Required. The url of the repository.
    class GooRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that allows executing scripts on the VM.
  #
  # The `ExecResource` has 2 stages: `validate` and `enforce` and both stages
  # accept a script as an argument to execute.
  #
  # When the `ExecResource` is applied by the agent, it first executes the
  # script in the `validate` stage. The `validate` stage can signal that the
  # `ExecResource` is already in the desired state by returning an exit code
  # of `100`. If the `ExecResource` is not in the desired state, it should
  # return an exit code of `101`. Any other exit code returned by this stage
  # is considered an error.
  #
  # If the `ExecResource` is not in the desired state based on the exit code
  # from the `validate` stage, the agent proceeds to execute the script from
  # the `enforce` stage. If the `ExecResource` is already in the desired
  # state, the `enforce` stage will not be run.
  # Similar to `validate` stage, the `enforce` stage should return an exit
  # code of `100` to indicate that the resource in now in its desired state.
  # Any other exit code is considered an error.
  #
  # NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to
  # have an explicit indicator of `in desired state`, `not in desired state`
  # and errors. Because, for example, Powershell will always return an exit
  # code of `0` unless an `exit` statement is provided in the script. So, for
  # reasons of consistency and being explicit, exit codes `100` and `101`
  # were chosen.
  # @!attribute [rw] validate
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     Required. What to run to validate this resource is in the desired
  #     state. An exit code of 100 indicates "in desired state", and exit code
  #     of 101 indicates "not in desired state". Any other exit code indicates
  #     a failure running validate.
  # @!attribute [rw] enforce
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     What to run to bring this resource into the desired state.
  #     An exit code of 100 indicates "success", any other exit code indicates
  #     a failure running enforce.
  class ExecResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A file or script to execute.
    # @!attribute [rw] file
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     A remote or local file.
    # @!attribute [rw] script
    #   @return [::String]
    #     An inline script.
    #     The size of the script is limited to 1024 characters.
    # @!attribute [rw] args
    #   @return [::Array<::String>]
    #     Optional arguments to pass to the source during execution.
    # @!attribute [rw] interpreter
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec::Interpreter]
    #     Required. The script interpreter to use.
    # @!attribute [rw] output_file_path
    #   @return [::String]
    #     Only recorded for enforce Exec.
    #     Path to an output file (that is created by this Exec) whose
    #     content will be recorded in OSPolicyResourceCompliance after a
    #     successful run. Absence or failure to read this file will result in
    #     this ExecResource being non-compliant. Output file size is limited to
    #     100K bytes.
    class Exec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The interpreter to use.
      module Interpreter
        # Invalid value, the request will return validation error.
        INTERPRETER_UNSPECIFIED = 0

        # If an interpreter is not specified, the
        # source is executed directly. This execution, without an
        # interpreter, only succeeds for executables and scripts that have <a
        # href="https://en.wikipedia.org/wiki/Shebang_(Unix)"
        # class="external">shebang lines</a>.
        NONE = 1

        # Indicates that the script runs with `/bin/sh` on Linux and
        # `cmd.exe` on Windows.
        SHELL = 2

        # Indicates that the script runs with PowerShell.
        POWERSHELL = 3
      end
    end
  end

  # A resource that manages the state of a file.
  # @!attribute [rw] file
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
  #     A remote or local source.
  # @!attribute [rw] content
  #   @return [::String]
  #     A a file with this content.
  #     The size of the content is limited to 1024 characters.
  # @!attribute [rw] path
  #   @return [::String]
  #     Required. The absolute path of the file within the VM.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::FileResource::DesiredState]
  #     Required. Desired state of the file.
  # @!attribute [rw] permissions
  #   @return [::String]
  #     Consists of three octal digits which represent, in
  #     order, the permissions of the owner, group, and other users for the
  #     file (similarly to the numeric mode used in the linux chmod
  #     utility). Each digit represents a three bit number with the 4 bit
  #     corresponding to the read permissions, the 2 bit corresponds to the
  #     write bit, and the one bit corresponds to the execute permission.
  #     Default behavior is 755.
  #
  #     Below are some examples of permissions and their associated values:
  #     read, write, and execute: 7
  #     read and execute: 5
  #     read and write: 6
  #     read only: 4
  class FileResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Desired state of the file.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure file at path is present.
      PRESENT = 1

      # Ensure file at path is absent.
      ABSENT = 2

      # Ensure the contents of the file at path matches. If the file does
      # not exist it will be created.
      CONTENTS_MATCH = 3
    end
  end
end

#file ⇒ ::Google::Cloud::OsConfig::V1::OSPolicy::Resource::FileResource

Returns File resource.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy.rb', line 106

class Resource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A remote or local file.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Remote]
  #     A generic remote file.
  # @!attribute [rw] gcs
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Gcs]
  #     A Cloud Storage object.
  # @!attribute [rw] local_path
  #   @return [::String]
  #     A local path within the VM to use.
  # @!attribute [rw] allow_insecure
  #   @return [::Boolean]
  #     Defaults to false. When false, files are subject to validations
  #     based on the file type:
  #
  #     Remote: A checksum must be specified.
  #     Cloud Storage: An object generation number must be specified.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies a file available via some URI.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI from which to fetch the object. It should contain both
    #     the protocol and path following the format `{protocol}://{location}`.
    # @!attribute [rw] sha256_checksum
    #   @return [::String]
    #     SHA256 checksum of the remote file.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies a file available as a Cloud Storage Object.
    # @!attribute [rw] bucket
    #   @return [::String]
    #     Required. Bucket of the Cloud Storage object.
    # @!attribute [rw] object
    #   @return [::String]
    #     Required. Name of the Cloud Storage object.
    # @!attribute [rw] generation
    #   @return [::Integer]
    #     Generation number of the Cloud Storage object.
    class Gcs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that manages a system package.
  # @!attribute [rw] desired_state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::DesiredState]
  #     Required. The desired state the agent should maintain for this package.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::APT]
  #     A package managed by Apt.
  # @!attribute [rw] deb
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Deb]
  #     A deb package file.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::YUM]
  #     A package managed by YUM.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Zypper]
  #     A package managed by Zypper.
  # @!attribute [rw] rpm
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::RPM]
  #     An rpm package file.
  # @!attribute [rw] googet
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::GooGet]
  #     A package managed by GooGet.
  # @!attribute [rw] msi
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::MSI]
  #     An MSI package.
  class PackageResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A deb package file. dpkg packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. A deb package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `dpkg -i package`
    #     - install when true: `apt-get update && apt-get -y install
    #     package.deb`
    class Deb
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by APT.
    # - install: `apt-get update && apt-get -y install [name]`
    # - remove: `apt-get -y remove [name]`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class APT
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An RPM package file. RPM packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. An rpm package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `rpm --upgrade --replacepkgs package.rpm`
    #     - install when true: `yum -y install package.rpm` or
    #     `zypper -y install package.rpm`
    class RPM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by YUM.
    # - install: `yum -y install package`
    # - remove: `yum -y remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class YUM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by Zypper.
    # - install: `zypper -y install package`
    # - remove: `zypper -y rm package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class Zypper
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by GooGet.
    # - install: `googet -noconfirm install package`
    # - remove: `googet -noconfirm remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class GooGet
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An MSI package. MSI packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. The MSI package.
    # @!attribute [rw] properties
    #   @return [::Array<::String>]
    #     Additional properties to use during installation.
    #     This should be in the format of Property=Setting.
    #     Appended to the defaults of `ACTION=INSTALL
    #     REBOOT=ReallySuppress`.
    class MSI
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The desired state that the OS Config agent maintains on the VM.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure that the package is installed.
      INSTALLED = 1

      # The agent ensures that the package is not installed and
      # uninstalls it if detected.
      REMOVED = 2
    end
  end

  # A resource that manages a package repository.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository]
  #     An Apt Repository.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::YumRepository]
  #     A Yum Repository.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::ZypperRepository]
  #     A Zypper Repository.
  # @!attribute [rw] goo
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::GooRepository]
  #     A Goo Repository.
  class RepositoryResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents a single apt package repository. These will be added to
    # a repo file that will be managed at
    # `/etc/apt/sources.list.d/google_osconfig.list`.
    # @!attribute [rw] archive_type
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository::ArchiveType]
    #     Required. Type of archive files in this repository.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI for this repository.
    # @!attribute [rw] distribution
    #   @return [::String]
    #     Required. Distribution of this repository.
    # @!attribute [rw] components
    #   @return [::Array<::String>]
    #     Required. List of components for this repository. Must contain at
    #     least one item.
    # @!attribute [rw] gpg_key
    #   @return [::String]
    #     URI of the key file for this repository. The agent maintains a
    #     keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
    class AptRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Type of archive.
      module ArchiveType
        # Unspecified is invalid.
        ARCHIVE_TYPE_UNSPECIFIED = 0

        # Deb indicates that the archive contains binary files.
        DEB = 1

        # Deb-src indicates that the archive contains source files.
        DEB_SRC = 2
      end
    end

    # Represents a single yum package repository. These are added to a
    # repo file that is managed at
    # `/etc/yum.repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is  the
    #     `repo id` in the yum config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for resource conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class YumRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a single zypper package repository. These are added to a
    # repo file that is managed at
    # `/etc/zypp/repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is the
    #     `repo id` in the zypper config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for GuestPolicy conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class ZypperRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a Goo package repository. These are added to a repo file
    # that is managed at
    # `C:/ProgramData/GooGet/repos/google_osconfig.repo`.
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. The name of the repository.
    # @!attribute [rw] url
    #   @return [::String]
    #     Required. The url of the repository.
    class GooRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that allows executing scripts on the VM.
  #
  # The `ExecResource` has 2 stages: `validate` and `enforce` and both stages
  # accept a script as an argument to execute.
  #
  # When the `ExecResource` is applied by the agent, it first executes the
  # script in the `validate` stage. The `validate` stage can signal that the
  # `ExecResource` is already in the desired state by returning an exit code
  # of `100`. If the `ExecResource` is not in the desired state, it should
  # return an exit code of `101`. Any other exit code returned by this stage
  # is considered an error.
  #
  # If the `ExecResource` is not in the desired state based on the exit code
  # from the `validate` stage, the agent proceeds to execute the script from
  # the `enforce` stage. If the `ExecResource` is already in the desired
  # state, the `enforce` stage will not be run.
  # Similar to `validate` stage, the `enforce` stage should return an exit
  # code of `100` to indicate that the resource in now in its desired state.
  # Any other exit code is considered an error.
  #
  # NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to
  # have an explicit indicator of `in desired state`, `not in desired state`
  # and errors. Because, for example, Powershell will always return an exit
  # code of `0` unless an `exit` statement is provided in the script. So, for
  # reasons of consistency and being explicit, exit codes `100` and `101`
  # were chosen.
  # @!attribute [rw] validate
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     Required. What to run to validate this resource is in the desired
  #     state. An exit code of 100 indicates "in desired state", and exit code
  #     of 101 indicates "not in desired state". Any other exit code indicates
  #     a failure running validate.
  # @!attribute [rw] enforce
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     What to run to bring this resource into the desired state.
  #     An exit code of 100 indicates "success", any other exit code indicates
  #     a failure running enforce.
  class ExecResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A file or script to execute.
    # @!attribute [rw] file
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     A remote or local file.
    # @!attribute [rw] script
    #   @return [::String]
    #     An inline script.
    #     The size of the script is limited to 1024 characters.
    # @!attribute [rw] args
    #   @return [::Array<::String>]
    #     Optional arguments to pass to the source during execution.
    # @!attribute [rw] interpreter
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec::Interpreter]
    #     Required. The script interpreter to use.
    # @!attribute [rw] output_file_path
    #   @return [::String]
    #     Only recorded for enforce Exec.
    #     Path to an output file (that is created by this Exec) whose
    #     content will be recorded in OSPolicyResourceCompliance after a
    #     successful run. Absence or failure to read this file will result in
    #     this ExecResource being non-compliant. Output file size is limited to
    #     100K bytes.
    class Exec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The interpreter to use.
      module Interpreter
        # Invalid value, the request will return validation error.
        INTERPRETER_UNSPECIFIED = 0

        # If an interpreter is not specified, the
        # source is executed directly. This execution, without an
        # interpreter, only succeeds for executables and scripts that have <a
        # href="https://en.wikipedia.org/wiki/Shebang_(Unix)"
        # class="external">shebang lines</a>.
        NONE = 1

        # Indicates that the script runs with `/bin/sh` on Linux and
        # `cmd.exe` on Windows.
        SHELL = 2

        # Indicates that the script runs with PowerShell.
        POWERSHELL = 3
      end
    end
  end

  # A resource that manages the state of a file.
  # @!attribute [rw] file
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
  #     A remote or local source.
  # @!attribute [rw] content
  #   @return [::String]
  #     A a file with this content.
  #     The size of the content is limited to 1024 characters.
  # @!attribute [rw] path
  #   @return [::String]
  #     Required. The absolute path of the file within the VM.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::FileResource::DesiredState]
  #     Required. Desired state of the file.
  # @!attribute [rw] permissions
  #   @return [::String]
  #     Consists of three octal digits which represent, in
  #     order, the permissions of the owner, group, and other users for the
  #     file (similarly to the numeric mode used in the linux chmod
  #     utility). Each digit represents a three bit number with the 4 bit
  #     corresponding to the read permissions, the 2 bit corresponds to the
  #     write bit, and the one bit corresponds to the execute permission.
  #     Default behavior is 755.
  #
  #     Below are some examples of permissions and their associated values:
  #     read, write, and execute: 7
  #     read and execute: 5
  #     read and write: 6
  #     read only: 4
  class FileResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Desired state of the file.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure file at path is present.
      PRESENT = 1

      # Ensure file at path is absent.
      ABSENT = 2

      # Ensure the contents of the file at path matches. If the file does
      # not exist it will be created.
      CONTENTS_MATCH = 3
    end
  end
end

#id ⇒ ::String

Returns Required. The id of the resource with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the OS policy.

Returns:

  • (::String) —

    Required. The id of the resource with the following restrictions:

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.
    • Must be unique within the OS policy.


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy.rb', line 106

class Resource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A remote or local file.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Remote]
  #     A generic remote file.
  # @!attribute [rw] gcs
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Gcs]
  #     A Cloud Storage object.
  # @!attribute [rw] local_path
  #   @return [::String]
  #     A local path within the VM to use.
  # @!attribute [rw] allow_insecure
  #   @return [::Boolean]
  #     Defaults to false. When false, files are subject to validations
  #     based on the file type:
  #
  #     Remote: A checksum must be specified.
  #     Cloud Storage: An object generation number must be specified.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies a file available via some URI.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI from which to fetch the object. It should contain both
    #     the protocol and path following the format `{protocol}://{location}`.
    # @!attribute [rw] sha256_checksum
    #   @return [::String]
    #     SHA256 checksum of the remote file.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies a file available as a Cloud Storage Object.
    # @!attribute [rw] bucket
    #   @return [::String]
    #     Required. Bucket of the Cloud Storage object.
    # @!attribute [rw] object
    #   @return [::String]
    #     Required. Name of the Cloud Storage object.
    # @!attribute [rw] generation
    #   @return [::Integer]
    #     Generation number of the Cloud Storage object.
    class Gcs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that manages a system package.
  # @!attribute [rw] desired_state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::DesiredState]
  #     Required. The desired state the agent should maintain for this package.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::APT]
  #     A package managed by Apt.
  # @!attribute [rw] deb
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Deb]
  #     A deb package file.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::YUM]
  #     A package managed by YUM.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Zypper]
  #     A package managed by Zypper.
  # @!attribute [rw] rpm
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::RPM]
  #     An rpm package file.
  # @!attribute [rw] googet
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::GooGet]
  #     A package managed by GooGet.
  # @!attribute [rw] msi
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::MSI]
  #     An MSI package.
  class PackageResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A deb package file. dpkg packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. A deb package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `dpkg -i package`
    #     - install when true: `apt-get update && apt-get -y install
    #     package.deb`
    class Deb
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by APT.
    # - install: `apt-get update && apt-get -y install [name]`
    # - remove: `apt-get -y remove [name]`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class APT
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An RPM package file. RPM packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. An rpm package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `rpm --upgrade --replacepkgs package.rpm`
    #     - install when true: `yum -y install package.rpm` or
    #     `zypper -y install package.rpm`
    class RPM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by YUM.
    # - install: `yum -y install package`
    # - remove: `yum -y remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class YUM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by Zypper.
    # - install: `zypper -y install package`
    # - remove: `zypper -y rm package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class Zypper
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by GooGet.
    # - install: `googet -noconfirm install package`
    # - remove: `googet -noconfirm remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class GooGet
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An MSI package. MSI packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. The MSI package.
    # @!attribute [rw] properties
    #   @return [::Array<::String>]
    #     Additional properties to use during installation.
    #     This should be in the format of Property=Setting.
    #     Appended to the defaults of `ACTION=INSTALL
    #     REBOOT=ReallySuppress`.
    class MSI
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The desired state that the OS Config agent maintains on the VM.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure that the package is installed.
      INSTALLED = 1

      # The agent ensures that the package is not installed and
      # uninstalls it if detected.
      REMOVED = 2
    end
  end

  # A resource that manages a package repository.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository]
  #     An Apt Repository.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::YumRepository]
  #     A Yum Repository.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::ZypperRepository]
  #     A Zypper Repository.
  # @!attribute [rw] goo
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::GooRepository]
  #     A Goo Repository.
  class RepositoryResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents a single apt package repository. These will be added to
    # a repo file that will be managed at
    # `/etc/apt/sources.list.d/google_osconfig.list`.
    # @!attribute [rw] archive_type
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository::ArchiveType]
    #     Required. Type of archive files in this repository.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI for this repository.
    # @!attribute [rw] distribution
    #   @return [::String]
    #     Required. Distribution of this repository.
    # @!attribute [rw] components
    #   @return [::Array<::String>]
    #     Required. List of components for this repository. Must contain at
    #     least one item.
    # @!attribute [rw] gpg_key
    #   @return [::String]
    #     URI of the key file for this repository. The agent maintains a
    #     keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
    class AptRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Type of archive.
      module ArchiveType
        # Unspecified is invalid.
        ARCHIVE_TYPE_UNSPECIFIED = 0

        # Deb indicates that the archive contains binary files.
        DEB = 1

        # Deb-src indicates that the archive contains source files.
        DEB_SRC = 2
      end
    end

    # Represents a single yum package repository. These are added to a
    # repo file that is managed at
    # `/etc/yum.repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is  the
    #     `repo id` in the yum config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for resource conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class YumRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a single zypper package repository. These are added to a
    # repo file that is managed at
    # `/etc/zypp/repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is the
    #     `repo id` in the zypper config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for GuestPolicy conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class ZypperRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a Goo package repository. These are added to a repo file
    # that is managed at
    # `C:/ProgramData/GooGet/repos/google_osconfig.repo`.
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. The name of the repository.
    # @!attribute [rw] url
    #   @return [::String]
    #     Required. The url of the repository.
    class GooRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that allows executing scripts on the VM.
  #
  # The `ExecResource` has 2 stages: `validate` and `enforce` and both stages
  # accept a script as an argument to execute.
  #
  # When the `ExecResource` is applied by the agent, it first executes the
  # script in the `validate` stage. The `validate` stage can signal that the
  # `ExecResource` is already in the desired state by returning an exit code
  # of `100`. If the `ExecResource` is not in the desired state, it should
  # return an exit code of `101`. Any other exit code returned by this stage
  # is considered an error.
  #
  # If the `ExecResource` is not in the desired state based on the exit code
  # from the `validate` stage, the agent proceeds to execute the script from
  # the `enforce` stage. If the `ExecResource` is already in the desired
  # state, the `enforce` stage will not be run.
  # Similar to `validate` stage, the `enforce` stage should return an exit
  # code of `100` to indicate that the resource in now in its desired state.
  # Any other exit code is considered an error.
  #
  # NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to
  # have an explicit indicator of `in desired state`, `not in desired state`
  # and errors. Because, for example, Powershell will always return an exit
  # code of `0` unless an `exit` statement is provided in the script. So, for
  # reasons of consistency and being explicit, exit codes `100` and `101`
  # were chosen.
  # @!attribute [rw] validate
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     Required. What to run to validate this resource is in the desired
  #     state. An exit code of 100 indicates "in desired state", and exit code
  #     of 101 indicates "not in desired state". Any other exit code indicates
  #     a failure running validate.
  # @!attribute [rw] enforce
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     What to run to bring this resource into the desired state.
  #     An exit code of 100 indicates "success", any other exit code indicates
  #     a failure running enforce.
  class ExecResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A file or script to execute.
    # @!attribute [rw] file
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     A remote or local file.
    # @!attribute [rw] script
    #   @return [::String]
    #     An inline script.
    #     The size of the script is limited to 1024 characters.
    # @!attribute [rw] args
    #   @return [::Array<::String>]
    #     Optional arguments to pass to the source during execution.
    # @!attribute [rw] interpreter
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec::Interpreter]
    #     Required. The script interpreter to use.
    # @!attribute [rw] output_file_path
    #   @return [::String]
    #     Only recorded for enforce Exec.
    #     Path to an output file (that is created by this Exec) whose
    #     content will be recorded in OSPolicyResourceCompliance after a
    #     successful run. Absence or failure to read this file will result in
    #     this ExecResource being non-compliant. Output file size is limited to
    #     100K bytes.
    class Exec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The interpreter to use.
      module Interpreter
        # Invalid value, the request will return validation error.
        INTERPRETER_UNSPECIFIED = 0

        # If an interpreter is not specified, the
        # source is executed directly. This execution, without an
        # interpreter, only succeeds for executables and scripts that have <a
        # href="https://en.wikipedia.org/wiki/Shebang_(Unix)"
        # class="external">shebang lines</a>.
        NONE = 1

        # Indicates that the script runs with `/bin/sh` on Linux and
        # `cmd.exe` on Windows.
        SHELL = 2

        # Indicates that the script runs with PowerShell.
        POWERSHELL = 3
      end
    end
  end

  # A resource that manages the state of a file.
  # @!attribute [rw] file
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
  #     A remote or local source.
  # @!attribute [rw] content
  #   @return [::String]
  #     A a file with this content.
  #     The size of the content is limited to 1024 characters.
  # @!attribute [rw] path
  #   @return [::String]
  #     Required. The absolute path of the file within the VM.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::FileResource::DesiredState]
  #     Required. Desired state of the file.
  # @!attribute [rw] permissions
  #   @return [::String]
  #     Consists of three octal digits which represent, in
  #     order, the permissions of the owner, group, and other users for the
  #     file (similarly to the numeric mode used in the linux chmod
  #     utility). Each digit represents a three bit number with the 4 bit
  #     corresponding to the read permissions, the 2 bit corresponds to the
  #     write bit, and the one bit corresponds to the execute permission.
  #     Default behavior is 755.
  #
  #     Below are some examples of permissions and their associated values:
  #     read, write, and execute: 7
  #     read and execute: 5
  #     read and write: 6
  #     read only: 4
  class FileResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Desired state of the file.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure file at path is present.
      PRESENT = 1

      # Ensure file at path is absent.
      ABSENT = 2

      # Ensure the contents of the file at path matches. If the file does
      # not exist it will be created.
      CONTENTS_MATCH = 3
    end
  end
end

#pkg ⇒ ::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource

Returns Package resource.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy.rb', line 106

class Resource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A remote or local file.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Remote]
  #     A generic remote file.
  # @!attribute [rw] gcs
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Gcs]
  #     A Cloud Storage object.
  # @!attribute [rw] local_path
  #   @return [::String]
  #     A local path within the VM to use.
  # @!attribute [rw] allow_insecure
  #   @return [::Boolean]
  #     Defaults to false. When false, files are subject to validations
  #     based on the file type:
  #
  #     Remote: A checksum must be specified.
  #     Cloud Storage: An object generation number must be specified.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies a file available via some URI.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI from which to fetch the object. It should contain both
    #     the protocol and path following the format `{protocol}://{location}`.
    # @!attribute [rw] sha256_checksum
    #   @return [::String]
    #     SHA256 checksum of the remote file.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies a file available as a Cloud Storage Object.
    # @!attribute [rw] bucket
    #   @return [::String]
    #     Required. Bucket of the Cloud Storage object.
    # @!attribute [rw] object
    #   @return [::String]
    #     Required. Name of the Cloud Storage object.
    # @!attribute [rw] generation
    #   @return [::Integer]
    #     Generation number of the Cloud Storage object.
    class Gcs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that manages a system package.
  # @!attribute [rw] desired_state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::DesiredState]
  #     Required. The desired state the agent should maintain for this package.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::APT]
  #     A package managed by Apt.
  # @!attribute [rw] deb
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Deb]
  #     A deb package file.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::YUM]
  #     A package managed by YUM.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Zypper]
  #     A package managed by Zypper.
  # @!attribute [rw] rpm
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::RPM]
  #     An rpm package file.
  # @!attribute [rw] googet
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::GooGet]
  #     A package managed by GooGet.
  # @!attribute [rw] msi
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::MSI]
  #     An MSI package.
  class PackageResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A deb package file. dpkg packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. A deb package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `dpkg -i package`
    #     - install when true: `apt-get update && apt-get -y install
    #     package.deb`
    class Deb
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by APT.
    # - install: `apt-get update && apt-get -y install [name]`
    # - remove: `apt-get -y remove [name]`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class APT
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An RPM package file. RPM packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. An rpm package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `rpm --upgrade --replacepkgs package.rpm`
    #     - install when true: `yum -y install package.rpm` or
    #     `zypper -y install package.rpm`
    class RPM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by YUM.
    # - install: `yum -y install package`
    # - remove: `yum -y remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class YUM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by Zypper.
    # - install: `zypper -y install package`
    # - remove: `zypper -y rm package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class Zypper
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by GooGet.
    # - install: `googet -noconfirm install package`
    # - remove: `googet -noconfirm remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class GooGet
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An MSI package. MSI packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. The MSI package.
    # @!attribute [rw] properties
    #   @return [::Array<::String>]
    #     Additional properties to use during installation.
    #     This should be in the format of Property=Setting.
    #     Appended to the defaults of `ACTION=INSTALL
    #     REBOOT=ReallySuppress`.
    class MSI
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The desired state that the OS Config agent maintains on the VM.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure that the package is installed.
      INSTALLED = 1

      # The agent ensures that the package is not installed and
      # uninstalls it if detected.
      REMOVED = 2
    end
  end

  # A resource that manages a package repository.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository]
  #     An Apt Repository.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::YumRepository]
  #     A Yum Repository.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::ZypperRepository]
  #     A Zypper Repository.
  # @!attribute [rw] goo
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::GooRepository]
  #     A Goo Repository.
  class RepositoryResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents a single apt package repository. These will be added to
    # a repo file that will be managed at
    # `/etc/apt/sources.list.d/google_osconfig.list`.
    # @!attribute [rw] archive_type
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository::ArchiveType]
    #     Required. Type of archive files in this repository.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI for this repository.
    # @!attribute [rw] distribution
    #   @return [::String]
    #     Required. Distribution of this repository.
    # @!attribute [rw] components
    #   @return [::Array<::String>]
    #     Required. List of components for this repository. Must contain at
    #     least one item.
    # @!attribute [rw] gpg_key
    #   @return [::String]
    #     URI of the key file for this repository. The agent maintains a
    #     keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
    class AptRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Type of archive.
      module ArchiveType
        # Unspecified is invalid.
        ARCHIVE_TYPE_UNSPECIFIED = 0

        # Deb indicates that the archive contains binary files.
        DEB = 1

        # Deb-src indicates that the archive contains source files.
        DEB_SRC = 2
      end
    end

    # Represents a single yum package repository. These are added to a
    # repo file that is managed at
    # `/etc/yum.repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is  the
    #     `repo id` in the yum config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for resource conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class YumRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a single zypper package repository. These are added to a
    # repo file that is managed at
    # `/etc/zypp/repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is the
    #     `repo id` in the zypper config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for GuestPolicy conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class ZypperRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a Goo package repository. These are added to a repo file
    # that is managed at
    # `C:/ProgramData/GooGet/repos/google_osconfig.repo`.
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. The name of the repository.
    # @!attribute [rw] url
    #   @return [::String]
    #     Required. The url of the repository.
    class GooRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that allows executing scripts on the VM.
  #
  # The `ExecResource` has 2 stages: `validate` and `enforce` and both stages
  # accept a script as an argument to execute.
  #
  # When the `ExecResource` is applied by the agent, it first executes the
  # script in the `validate` stage. The `validate` stage can signal that the
  # `ExecResource` is already in the desired state by returning an exit code
  # of `100`. If the `ExecResource` is not in the desired state, it should
  # return an exit code of `101`. Any other exit code returned by this stage
  # is considered an error.
  #
  # If the `ExecResource` is not in the desired state based on the exit code
  # from the `validate` stage, the agent proceeds to execute the script from
  # the `enforce` stage. If the `ExecResource` is already in the desired
  # state, the `enforce` stage will not be run.
  # Similar to `validate` stage, the `enforce` stage should return an exit
  # code of `100` to indicate that the resource in now in its desired state.
  # Any other exit code is considered an error.
  #
  # NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to
  # have an explicit indicator of `in desired state`, `not in desired state`
  # and errors. Because, for example, Powershell will always return an exit
  # code of `0` unless an `exit` statement is provided in the script. So, for
  # reasons of consistency and being explicit, exit codes `100` and `101`
  # were chosen.
  # @!attribute [rw] validate
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     Required. What to run to validate this resource is in the desired
  #     state. An exit code of 100 indicates "in desired state", and exit code
  #     of 101 indicates "not in desired state". Any other exit code indicates
  #     a failure running validate.
  # @!attribute [rw] enforce
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     What to run to bring this resource into the desired state.
  #     An exit code of 100 indicates "success", any other exit code indicates
  #     a failure running enforce.
  class ExecResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A file or script to execute.
    # @!attribute [rw] file
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     A remote or local file.
    # @!attribute [rw] script
    #   @return [::String]
    #     An inline script.
    #     The size of the script is limited to 1024 characters.
    # @!attribute [rw] args
    #   @return [::Array<::String>]
    #     Optional arguments to pass to the source during execution.
    # @!attribute [rw] interpreter
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec::Interpreter]
    #     Required. The script interpreter to use.
    # @!attribute [rw] output_file_path
    #   @return [::String]
    #     Only recorded for enforce Exec.
    #     Path to an output file (that is created by this Exec) whose
    #     content will be recorded in OSPolicyResourceCompliance after a
    #     successful run. Absence or failure to read this file will result in
    #     this ExecResource being non-compliant. Output file size is limited to
    #     100K bytes.
    class Exec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The interpreter to use.
      module Interpreter
        # Invalid value, the request will return validation error.
        INTERPRETER_UNSPECIFIED = 0

        # If an interpreter is not specified, the
        # source is executed directly. This execution, without an
        # interpreter, only succeeds for executables and scripts that have <a
        # href="https://en.wikipedia.org/wiki/Shebang_(Unix)"
        # class="external">shebang lines</a>.
        NONE = 1

        # Indicates that the script runs with `/bin/sh` on Linux and
        # `cmd.exe` on Windows.
        SHELL = 2

        # Indicates that the script runs with PowerShell.
        POWERSHELL = 3
      end
    end
  end

  # A resource that manages the state of a file.
  # @!attribute [rw] file
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
  #     A remote or local source.
  # @!attribute [rw] content
  #   @return [::String]
  #     A a file with this content.
  #     The size of the content is limited to 1024 characters.
  # @!attribute [rw] path
  #   @return [::String]
  #     Required. The absolute path of the file within the VM.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::FileResource::DesiredState]
  #     Required. Desired state of the file.
  # @!attribute [rw] permissions
  #   @return [::String]
  #     Consists of three octal digits which represent, in
  #     order, the permissions of the owner, group, and other users for the
  #     file (similarly to the numeric mode used in the linux chmod
  #     utility). Each digit represents a three bit number with the 4 bit
  #     corresponding to the read permissions, the 2 bit corresponds to the
  #     write bit, and the one bit corresponds to the execute permission.
  #     Default behavior is 755.
  #
  #     Below are some examples of permissions and their associated values:
  #     read, write, and execute: 7
  #     read and execute: 5
  #     read and write: 6
  #     read only: 4
  class FileResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Desired state of the file.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure file at path is present.
      PRESENT = 1

      # Ensure file at path is absent.
      ABSENT = 2

      # Ensure the contents of the file at path matches. If the file does
      # not exist it will be created.
      CONTENTS_MATCH = 3
    end
  end
end

#repository ⇒ ::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource

Returns Package repository resource.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy.rb', line 106

class Resource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A remote or local file.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Remote]
  #     A generic remote file.
  # @!attribute [rw] gcs
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File::Gcs]
  #     A Cloud Storage object.
  # @!attribute [rw] local_path
  #   @return [::String]
  #     A local path within the VM to use.
  # @!attribute [rw] allow_insecure
  #   @return [::Boolean]
  #     Defaults to false. When false, files are subject to validations
  #     based on the file type:
  #
  #     Remote: A checksum must be specified.
  #     Cloud Storage: An object generation number must be specified.
  class File
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies a file available via some URI.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI from which to fetch the object. It should contain both
    #     the protocol and path following the format `{protocol}://{location}`.
    # @!attribute [rw] sha256_checksum
    #   @return [::String]
    #     SHA256 checksum of the remote file.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specifies a file available as a Cloud Storage Object.
    # @!attribute [rw] bucket
    #   @return [::String]
    #     Required. Bucket of the Cloud Storage object.
    # @!attribute [rw] object
    #   @return [::String]
    #     Required. Name of the Cloud Storage object.
    # @!attribute [rw] generation
    #   @return [::Integer]
    #     Generation number of the Cloud Storage object.
    class Gcs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that manages a system package.
  # @!attribute [rw] desired_state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::DesiredState]
  #     Required. The desired state the agent should maintain for this package.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::APT]
  #     A package managed by Apt.
  # @!attribute [rw] deb
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Deb]
  #     A deb package file.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::YUM]
  #     A package managed by YUM.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::Zypper]
  #     A package managed by Zypper.
  # @!attribute [rw] rpm
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::RPM]
  #     An rpm package file.
  # @!attribute [rw] googet
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::GooGet]
  #     A package managed by GooGet.
  # @!attribute [rw] msi
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::PackageResource::MSI]
  #     An MSI package.
  class PackageResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A deb package file. dpkg packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. A deb package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `dpkg -i package`
    #     - install when true: `apt-get update && apt-get -y install
    #     package.deb`
    class Deb
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by APT.
    # - install: `apt-get update && apt-get -y install [name]`
    # - remove: `apt-get -y remove [name]`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class APT
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An RPM package file. RPM packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. An rpm package.
    # @!attribute [rw] pull_deps
    #   @return [::Boolean]
    #     Whether dependencies should also be installed.
    #     - install when false: `rpm --upgrade --replacepkgs package.rpm`
    #     - install when true: `yum -y install package.rpm` or
    #     `zypper -y install package.rpm`
    class RPM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by YUM.
    # - install: `yum -y install package`
    # - remove: `yum -y remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class YUM
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by Zypper.
    # - install: `zypper -y install package`
    # - remove: `zypper -y rm package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class Zypper
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A package managed by GooGet.
    # - install: `googet -noconfirm install package`
    # - remove: `googet -noconfirm remove package`
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. Package name.
    class GooGet
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An MSI package. MSI packages only support INSTALLED state.
    # @!attribute [rw] source
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     Required. The MSI package.
    # @!attribute [rw] properties
    #   @return [::Array<::String>]
    #     Additional properties to use during installation.
    #     This should be in the format of Property=Setting.
    #     Appended to the defaults of `ACTION=INSTALL
    #     REBOOT=ReallySuppress`.
    class MSI
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The desired state that the OS Config agent maintains on the VM.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure that the package is installed.
      INSTALLED = 1

      # The agent ensures that the package is not installed and
      # uninstalls it if detected.
      REMOVED = 2
    end
  end

  # A resource that manages a package repository.
  # @!attribute [rw] apt
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository]
  #     An Apt Repository.
  # @!attribute [rw] yum
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::YumRepository]
  #     A Yum Repository.
  # @!attribute [rw] zypper
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::ZypperRepository]
  #     A Zypper Repository.
  # @!attribute [rw] goo
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::GooRepository]
  #     A Goo Repository.
  class RepositoryResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents a single apt package repository. These will be added to
    # a repo file that will be managed at
    # `/etc/apt/sources.list.d/google_osconfig.list`.
    # @!attribute [rw] archive_type
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::RepositoryResource::AptRepository::ArchiveType]
    #     Required. Type of archive files in this repository.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Required. URI for this repository.
    # @!attribute [rw] distribution
    #   @return [::String]
    #     Required. Distribution of this repository.
    # @!attribute [rw] components
    #   @return [::Array<::String>]
    #     Required. List of components for this repository. Must contain at
    #     least one item.
    # @!attribute [rw] gpg_key
    #   @return [::String]
    #     URI of the key file for this repository. The agent maintains a
    #     keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
    class AptRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Type of archive.
      module ArchiveType
        # Unspecified is invalid.
        ARCHIVE_TYPE_UNSPECIFIED = 0

        # Deb indicates that the archive contains binary files.
        DEB = 1

        # Deb-src indicates that the archive contains source files.
        DEB_SRC = 2
      end
    end

    # Represents a single yum package repository. These are added to a
    # repo file that is managed at
    # `/etc/yum.repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is  the
    #     `repo id` in the yum config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for resource conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class YumRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a single zypper package repository. These are added to a
    # repo file that is managed at
    # `/etc/zypp/repos.d/google_osconfig.repo`.
    # @!attribute [rw] id
    #   @return [::String]
    #     Required. A one word, unique name for this repository. This is the
    #     `repo id` in the zypper config file and also the `display_name` if
    #     `display_name` is omitted. This id is also used as the unique
    #     identifier when checking for GuestPolicy conflicts.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The display name of the repository.
    # @!attribute [rw] base_url
    #   @return [::String]
    #     Required. The location of the repository directory.
    # @!attribute [rw] gpg_keys
    #   @return [::Array<::String>]
    #     URIs of GPG keys.
    class ZypperRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents a Goo package repository. These are added to a repo file
    # that is managed at
    # `C:/ProgramData/GooGet/repos/google_osconfig.repo`.
    # @!attribute [rw] name
    #   @return [::String]
    #     Required. The name of the repository.
    # @!attribute [rw] url
    #   @return [::String]
    #     Required. The url of the repository.
    class GooRepository
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A resource that allows executing scripts on the VM.
  #
  # The `ExecResource` has 2 stages: `validate` and `enforce` and both stages
  # accept a script as an argument to execute.
  #
  # When the `ExecResource` is applied by the agent, it first executes the
  # script in the `validate` stage. The `validate` stage can signal that the
  # `ExecResource` is already in the desired state by returning an exit code
  # of `100`. If the `ExecResource` is not in the desired state, it should
  # return an exit code of `101`. Any other exit code returned by this stage
  # is considered an error.
  #
  # If the `ExecResource` is not in the desired state based on the exit code
  # from the `validate` stage, the agent proceeds to execute the script from
  # the `enforce` stage. If the `ExecResource` is already in the desired
  # state, the `enforce` stage will not be run.
  # Similar to `validate` stage, the `enforce` stage should return an exit
  # code of `100` to indicate that the resource in now in its desired state.
  # Any other exit code is considered an error.
  #
  # NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to
  # have an explicit indicator of `in desired state`, `not in desired state`
  # and errors. Because, for example, Powershell will always return an exit
  # code of `0` unless an `exit` statement is provided in the script. So, for
  # reasons of consistency and being explicit, exit codes `100` and `101`
  # were chosen.
  # @!attribute [rw] validate
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     Required. What to run to validate this resource is in the desired
  #     state. An exit code of 100 indicates "in desired state", and exit code
  #     of 101 indicates "not in desired state". Any other exit code indicates
  #     a failure running validate.
  # @!attribute [rw] enforce
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec]
  #     What to run to bring this resource into the desired state.
  #     An exit code of 100 indicates "success", any other exit code indicates
  #     a failure running enforce.
  class ExecResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A file or script to execute.
    # @!attribute [rw] file
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
    #     A remote or local file.
    # @!attribute [rw] script
    #   @return [::String]
    #     An inline script.
    #     The size of the script is limited to 1024 characters.
    # @!attribute [rw] args
    #   @return [::Array<::String>]
    #     Optional arguments to pass to the source during execution.
    # @!attribute [rw] interpreter
    #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::ExecResource::Exec::Interpreter]
    #     Required. The script interpreter to use.
    # @!attribute [rw] output_file_path
    #   @return [::String]
    #     Only recorded for enforce Exec.
    #     Path to an output file (that is created by this Exec) whose
    #     content will be recorded in OSPolicyResourceCompliance after a
    #     successful run. Absence or failure to read this file will result in
    #     this ExecResource being non-compliant. Output file size is limited to
    #     100K bytes.
    class Exec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The interpreter to use.
      module Interpreter
        # Invalid value, the request will return validation error.
        INTERPRETER_UNSPECIFIED = 0

        # If an interpreter is not specified, the
        # source is executed directly. This execution, without an
        # interpreter, only succeeds for executables and scripts that have <a
        # href="https://en.wikipedia.org/wiki/Shebang_(Unix)"
        # class="external">shebang lines</a>.
        NONE = 1

        # Indicates that the script runs with `/bin/sh` on Linux and
        # `cmd.exe` on Windows.
        SHELL = 2

        # Indicates that the script runs with PowerShell.
        POWERSHELL = 3
      end
    end
  end

  # A resource that manages the state of a file.
  # @!attribute [rw] file
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::File]
  #     A remote or local source.
  # @!attribute [rw] content
  #   @return [::String]
  #     A a file with this content.
  #     The size of the content is limited to 1024 characters.
  # @!attribute [rw] path
  #   @return [::String]
  #     Required. The absolute path of the file within the VM.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicy::Resource::FileResource::DesiredState]
  #     Required. Desired state of the file.
  # @!attribute [rw] permissions
  #   @return [::String]
  #     Consists of three octal digits which represent, in
  #     order, the permissions of the owner, group, and other users for the
  #     file (similarly to the numeric mode used in the linux chmod
  #     utility). Each digit represents a three bit number with the 4 bit
  #     corresponding to the read permissions, the 2 bit corresponds to the
  #     write bit, and the one bit corresponds to the execute permission.
  #     Default behavior is 755.
  #
  #     Below are some examples of permissions and their associated values:
  #     read, write, and execute: 7
  #     read and execute: 5
  #     read and write: 6
  #     read only: 4
  class FileResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Desired state of the file.
    module DesiredState
      # Unspecified is invalid.
      DESIRED_STATE_UNSPECIFIED = 0

      # Ensure file at path is present.
      PRESENT = 1

      # Ensure file at path is absent.
      ABSENT = 2

      # Ensure the contents of the file at path matches. If the file does
      # not exist it will be created.
      CONTENTS_MATCH = 3
    end
  end
end