grafeas-v1 1.1.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cfac8221d4b0f0fa86421f6227bcc1ff67099630640c414df8a79784918a8a1c
4
- data.tar.gz: 1b5716c6a135b906e3a7f6f0fe03bb466fa1e7d031caa75d83d80458eb92bf1e
3
+ metadata.gz: 6e77eb2f8f06c7c44ee5b80b5cab7661f4a10d4f9fd13bb4cbef386b08cecf37
4
+ data.tar.gz: b226bfcc17f8cb2ad5fd17fbb6c2ea9c8679d078c8f1a755a1c261e1629cf9ad
5
5
  SHA512:
6
- metadata.gz: e353e4aad9dc3eb4549095a0af918fb60946bfe5ac56b37b6fa3480f21f93c0629010c02a55ba71d8acf57a9d1b7aaf88e33b0fd7d008ba6d437a356d6bf413e
7
- data.tar.gz: cd1b30a0390e82f7c60755d3f73e1a2e6dd84e3c428cf49d8c9fc739411c0c061b39b42a8bd642419fc2366cd1dfa5e3ba234bca224a622c4d00cfe32ed4fe5e
6
+ metadata.gz: 579d9cc32f2c093dded26110321ad8ba53bdd78b2324632691c0eba850d11243f3a4a1d7d762451c2b2fb29cedcde6f6a35950063846d1fa0dd46f5f8e9dd66b
7
+ data.tar.gz: 8ed1916c7f270f120a1b3c6ec973554142b020dc668ce7d571d37768d0eba87328a4e9dd8df52b9e4c3c66ed5c0d9525ee45c2ee65fae7ef414850fe7bc770c2
data/README.md CHANGED
@@ -31,40 +31,50 @@ response = client.get_occurrence request
31
31
  View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/grafeas-v1/latest)
32
32
  for class and method documentation.
33
33
 
34
- ## Enabling Logging
35
-
36
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
37
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
38
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
39
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
40
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
41
-
42
- Configuring a Ruby stdlib logger:
34
+ ## Debug Logging
35
+
36
+ This library comes with opt-in Debug Logging that can help you troubleshoot
37
+ your application's integration with the API. When logging is activated, key
38
+ events such as requests and responses, along with data payloads and metadata
39
+ such as headers and client configuration, are logged to the standard error
40
+ stream.
41
+
42
+ **WARNING:** Client Library Debug Logging includes your data payloads in
43
+ plaintext, which could include sensitive data such as PII for yourself or your
44
+ customers, private keys, or other security data that could be compromising if
45
+ leaked. Always practice good data hygiene with your application logs, and follow
46
+ the principle of least access. Google also recommends that Client Library Debug
47
+ Logging be enabled only temporarily during active debugging, and not used
48
+ permanently in production.
49
+
50
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
51
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
52
+ list of client library gem names. This will select the default logging behavior,
53
+ which writes logs to the standard error stream. On a local workstation, this may
54
+ result in logs appearing on the console. When running on a Google Cloud hosting
55
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
56
+ results in logs appearing alongside your application logs in the
57
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
58
+
59
+ You can customize logging by modifying the `logger` configuration when
60
+ constructing a client object. For example:
43
61
 
44
62
  ```ruby
63
+ require "grafeas/v1"
45
64
  require "logger"
46
65
 
47
- module MyLogger
48
- LOGGER = Logger.new $stderr, level: Logger::WARN
49
- def logger
50
- LOGGER
51
- end
52
- end
53
-
54
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
55
- module GRPC
56
- extend MyLogger
66
+ client = ::Grafeas::V1::Grafeas::Client.new do |config|
67
+ config.logger = Logger.new "my-app.log"
57
68
  end
58
69
  ```
59
70
 
60
-
61
71
  ## Google Cloud Samples
62
72
 
63
73
  To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
64
74
 
65
75
  ## Supported Ruby Versions
66
76
 
67
- This library is supported on Ruby 2.7+.
77
+ This library is supported on Ruby 3.0+.
68
78
 
69
79
  Google provides official support for Ruby versions that are actively supported
70
80
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -210,8 +210,28 @@ module Grafeas
210
210
  universe_domain: @config.universe_domain,
211
211
  channel_args: @config.channel_args,
212
212
  interceptors: @config.interceptors,
213
- channel_pool_config: @config.channel_pool
213
+ channel_pool_config: @config.channel_pool,
214
+ logger: @config.logger
214
215
  )
216
+
217
+ @grafeas_stub.stub_logger&.info do |entry|
218
+ entry.set_system_name
219
+ entry.set_service
220
+ entry.message = "Created client for #{entry.service}"
221
+ entry.set_credentials_fields credentials
222
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
223
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
224
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
225
+ end
226
+ end
227
+
228
+ ##
229
+ # The logger used for request/response debug logging.
230
+ #
231
+ # @return [Logger]
232
+ #
233
+ def logger
234
+ @grafeas_stub.logger
215
235
  end
216
236
 
217
237
  # Service calls
@@ -297,7 +317,6 @@ module Grafeas
297
317
 
298
318
  @grafeas_stub.call_rpc :get_occurrence, request, options: options do |response, operation|
299
319
  yield response, operation if block_given?
300
- return response
301
320
  end
302
321
  rescue ::GRPC::BadStatus => e
303
322
  raise ::Google::Cloud::Error.from_error(e)
@@ -396,7 +415,7 @@ module Grafeas
396
415
  @grafeas_stub.call_rpc :list_occurrences, request, options: options do |response, operation|
397
416
  response = ::Gapic::PagedEnumerable.new @grafeas_stub, :list_occurrences, request, response, operation, options
398
417
  yield response, operation if block_given?
399
- return response
418
+ throw :response, response
400
419
  end
401
420
  rescue ::GRPC::BadStatus => e
402
421
  raise ::Google::Cloud::Error.from_error(e)
@@ -485,7 +504,6 @@ module Grafeas
485
504
 
486
505
  @grafeas_stub.call_rpc :delete_occurrence, request, options: options do |response, operation|
487
506
  yield response, operation if block_given?
488
- return response
489
507
  end
490
508
  rescue ::GRPC::BadStatus => e
491
509
  raise ::Google::Cloud::Error.from_error(e)
@@ -574,7 +592,6 @@ module Grafeas
574
592
 
575
593
  @grafeas_stub.call_rpc :create_occurrence, request, options: options do |response, operation|
576
594
  yield response, operation if block_given?
577
- return response
578
595
  end
579
596
  rescue ::GRPC::BadStatus => e
580
597
  raise ::Google::Cloud::Error.from_error(e)
@@ -663,7 +680,6 @@ module Grafeas
663
680
 
664
681
  @grafeas_stub.call_rpc :batch_create_occurrences, request, options: options do |response, operation|
665
682
  yield response, operation if block_given?
666
- return response
667
683
  end
668
684
  rescue ::GRPC::BadStatus => e
669
685
  raise ::Google::Cloud::Error.from_error(e)
@@ -754,7 +770,6 @@ module Grafeas
754
770
 
755
771
  @grafeas_stub.call_rpc :update_occurrence, request, options: options do |response, operation|
756
772
  yield response, operation if block_given?
757
- return response
758
773
  end
759
774
  rescue ::GRPC::BadStatus => e
760
775
  raise ::Google::Cloud::Error.from_error(e)
@@ -842,7 +857,6 @@ module Grafeas
842
857
 
843
858
  @grafeas_stub.call_rpc :get_occurrence_note, request, options: options do |response, operation|
844
859
  yield response, operation if block_given?
845
- return response
846
860
  end
847
861
  rescue ::GRPC::BadStatus => e
848
862
  raise ::Google::Cloud::Error.from_error(e)
@@ -929,7 +943,6 @@ module Grafeas
929
943
 
930
944
  @grafeas_stub.call_rpc :get_note, request, options: options do |response, operation|
931
945
  yield response, operation if block_given?
932
- return response
933
946
  end
934
947
  rescue ::GRPC::BadStatus => e
935
948
  raise ::Google::Cloud::Error.from_error(e)
@@ -1028,7 +1041,7 @@ module Grafeas
1028
1041
  @grafeas_stub.call_rpc :list_notes, request, options: options do |response, operation|
1029
1042
  response = ::Gapic::PagedEnumerable.new @grafeas_stub, :list_notes, request, response, operation, options
1030
1043
  yield response, operation if block_given?
1031
- return response
1044
+ throw :response, response
1032
1045
  end
1033
1046
  rescue ::GRPC::BadStatus => e
1034
1047
  raise ::Google::Cloud::Error.from_error(e)
@@ -1115,7 +1128,6 @@ module Grafeas
1115
1128
 
1116
1129
  @grafeas_stub.call_rpc :delete_note, request, options: options do |response, operation|
1117
1130
  yield response, operation if block_given?
1118
- return response
1119
1131
  end
1120
1132
  rescue ::GRPC::BadStatus => e
1121
1133
  raise ::Google::Cloud::Error.from_error(e)
@@ -1206,7 +1218,6 @@ module Grafeas
1206
1218
 
1207
1219
  @grafeas_stub.call_rpc :create_note, request, options: options do |response, operation|
1208
1220
  yield response, operation if block_given?
1209
- return response
1210
1221
  end
1211
1222
  rescue ::GRPC::BadStatus => e
1212
1223
  raise ::Google::Cloud::Error.from_error(e)
@@ -1295,7 +1306,6 @@ module Grafeas
1295
1306
 
1296
1307
  @grafeas_stub.call_rpc :batch_create_notes, request, options: options do |response, operation|
1297
1308
  yield response, operation if block_given?
1298
- return response
1299
1309
  end
1300
1310
  rescue ::GRPC::BadStatus => e
1301
1311
  raise ::Google::Cloud::Error.from_error(e)
@@ -1386,7 +1396,6 @@ module Grafeas
1386
1396
 
1387
1397
  @grafeas_stub.call_rpc :update_note, request, options: options do |response, operation|
1388
1398
  yield response, operation if block_given?
1389
- return response
1390
1399
  end
1391
1400
  rescue ::GRPC::BadStatus => e
1392
1401
  raise ::Google::Cloud::Error.from_error(e)
@@ -1486,7 +1495,7 @@ module Grafeas
1486
1495
  @grafeas_stub.call_rpc :list_note_occurrences, request, options: options do |response, operation|
1487
1496
  response = ::Gapic::PagedEnumerable.new @grafeas_stub, :list_note_occurrences, request, response, operation, options
1488
1497
  yield response, operation if block_given?
1489
- return response
1498
+ throw :response, response
1490
1499
  end
1491
1500
  rescue ::GRPC::BadStatus => e
1492
1501
  raise ::Google::Cloud::Error.from_error(e)
@@ -1536,6 +1545,13 @@ module Grafeas
1536
1545
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
1537
1546
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1538
1547
  # * (`nil`) indicating no credentials
1548
+ #
1549
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1550
+ # external source for authentication to Google Cloud, you must validate it before
1551
+ # providing it to a Google API client library. Providing an unvalidated credential
1552
+ # configuration to Google APIs can compromise the security of your systems and data.
1553
+ # For more information, refer to [Validate credential configurations from external
1554
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
1539
1555
  # @return [::Object]
1540
1556
  # @!attribute [rw] scope
1541
1557
  # The OAuth scopes
@@ -1575,6 +1591,11 @@ module Grafeas
1575
1591
  # default endpoint URL. The default value of nil uses the environment
1576
1592
  # universe (usually the default "googleapis.com" universe).
1577
1593
  # @return [::String,nil]
1594
+ # @!attribute [rw] logger
1595
+ # A custom logger to use for request/response debug logging, or the value
1596
+ # `:default` (the default) to construct a default logger, or `nil` to
1597
+ # explicitly disable logging.
1598
+ # @return [::Logger,:default,nil]
1578
1599
  #
1579
1600
  class Configuration
1580
1601
  extend ::Gapic::Config
@@ -1599,6 +1620,7 @@ module Grafeas
1599
1620
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1600
1621
  config_attr :quota_project, nil, ::String, nil
1601
1622
  config_attr :universe_domain, nil, ::String, nil
1623
+ config_attr :logger, :default, ::Logger, nil, :default
1602
1624
 
1603
1625
  # @private
1604
1626
  def initialize parent_config = nil
@@ -19,6 +19,6 @@
19
19
 
20
20
  module Grafeas
21
21
  module V1
22
- VERSION = "1.1.1"
22
+ VERSION = "1.3.0"
23
23
  end
24
24
  end
@@ -28,6 +28,9 @@ module Google
28
28
  # @!attribute [rw] destinations
29
29
  # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
30
  # The destination where API teams want this client library to be published.
31
+ # @!attribute [rw] selective_gapic_generation
32
+ # @return [::Google::Api::SelectiveGapicGeneration]
33
+ # Configuration for which RPCs should be generated in the GAPIC client.
31
34
  class CommonLanguageSettings
32
35
  include ::Google::Protobuf::MessageExts
33
36
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
212
215
  # enabled. By default, asynchronous REST clients will not be generated.
213
216
  # This feature will be enabled by default 1 month after launching the
214
217
  # feature in preview packages.
218
+ # @!attribute [rw] protobuf_pythonic_types_enabled
219
+ # @return [::Boolean]
220
+ # Enables generation of protobuf code using new types that are more
221
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
+ # enabled by default 1 month after launching the feature in preview
223
+ # packages.
215
224
  class ExperimentalFeatures
216
225
  include ::Google::Protobuf::MessageExts
217
226
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,9 +306,28 @@ module Google
297
306
  # @!attribute [rw] common
298
307
  # @return [::Google::Api::CommonLanguageSettings]
299
308
  # Some settings.
309
+ # @!attribute [rw] renamed_services
310
+ # @return [::Google::Protobuf::Map{::String => ::String}]
311
+ # Map of service names to renamed services. Keys are the package relative
312
+ # service names and values are the name to be used for the service client
313
+ # and call options.
314
+ #
315
+ # publishing:
316
+ # go_settings:
317
+ # renamed_services:
318
+ # Publisher: TopicAdmin
300
319
  class GoSettings
301
320
  include ::Google::Protobuf::MessageExts
302
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
+
323
+ # @!attribute [rw] key
324
+ # @return [::String]
325
+ # @!attribute [rw] value
326
+ # @return [::String]
327
+ class RenamedServicesEntry
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
303
331
  end
304
332
 
305
333
  # Describes the generator configuration for a method.
@@ -375,6 +403,17 @@ module Google
375
403
  end
376
404
  end
377
405
 
406
+ # This message is used to configure the generation of a subset of the RPCs in
407
+ # a service for client libraries.
408
+ # @!attribute [rw] methods
409
+ # @return [::Array<::String>]
410
+ # An allowlist of the fully qualified names of RPCs that should be included
411
+ # on public client surfaces.
412
+ class SelectiveGapicGeneration
413
+ include ::Google::Protobuf::MessageExts
414
+ extend ::Google::Protobuf::MessageExts::ClassMethods
415
+ end
416
+
378
417
  # The organization for which the client libraries are being published.
379
418
  # Affects the url where generated docs are published, etc.
380
419
  module ClientLibraryOrganization
@@ -53,21 +53,33 @@ module Google
53
53
  # @!attribute [rw] null_value
54
54
  # @return [::Google::Protobuf::NullValue]
55
55
  # Represents a null value.
56
+ #
57
+ # Note: The following fields are mutually exclusive: `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
56
58
  # @!attribute [rw] number_value
57
59
  # @return [::Float]
58
60
  # Represents a double value.
61
+ #
62
+ # Note: The following fields are mutually exclusive: `number_value`, `null_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
59
63
  # @!attribute [rw] string_value
60
64
  # @return [::String]
61
65
  # Represents a string value.
66
+ #
67
+ # Note: The following fields are mutually exclusive: `string_value`, `null_value`, `number_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
62
68
  # @!attribute [rw] bool_value
63
69
  # @return [::Boolean]
64
70
  # Represents a boolean value.
71
+ #
72
+ # Note: The following fields are mutually exclusive: `bool_value`, `null_value`, `number_value`, `string_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
65
73
  # @!attribute [rw] struct_value
66
74
  # @return [::Google::Protobuf::Struct]
67
75
  # Represents a structured value.
76
+ #
77
+ # Note: The following fields are mutually exclusive: `struct_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
68
78
  # @!attribute [rw] list_value
69
79
  # @return [::Google::Protobuf::ListValue]
70
80
  # Represents a repeated `Value`.
81
+ #
82
+ # Note: The following fields are mutually exclusive: `list_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
71
83
  class Value
72
84
  include ::Google::Protobuf::MessageExts
73
85
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -50,37 +50,59 @@ module Grafeas
50
50
  # @!attribute [rw] vulnerability
51
51
  # @return [::Grafeas::V1::VulnerabilityOccurrence]
52
52
  # Describes a security vulnerability.
53
+ #
54
+ # Note: The following fields are mutually exclusive: `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
53
55
  # @!attribute [rw] build
54
56
  # @return [::Grafeas::V1::BuildOccurrence]
55
57
  # Describes a verifiable build.
58
+ #
59
+ # Note: The following fields are mutually exclusive: `build`, `vulnerability`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
56
60
  # @!attribute [rw] image
57
61
  # @return [::Grafeas::V1::ImageOccurrence]
58
62
  # Describes how this resource derives from the basis in the associated
59
63
  # note.
64
+ #
65
+ # Note: The following fields are mutually exclusive: `image`, `vulnerability`, `build`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
60
66
  # @!attribute [rw] package
61
67
  # @return [::Grafeas::V1::PackageOccurrence]
62
68
  # Describes the installation of a package on the linked resource.
69
+ #
70
+ # Note: The following fields are mutually exclusive: `package`, `vulnerability`, `build`, `image`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
63
71
  # @!attribute [rw] deployment
64
72
  # @return [::Grafeas::V1::DeploymentOccurrence]
65
73
  # Describes the deployment of an artifact on a runtime.
74
+ #
75
+ # Note: The following fields are mutually exclusive: `deployment`, `vulnerability`, `build`, `image`, `package`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
66
76
  # @!attribute [rw] discovery
67
77
  # @return [::Grafeas::V1::DiscoveryOccurrence]
68
78
  # Describes when a resource was discovered.
79
+ #
80
+ # Note: The following fields are mutually exclusive: `discovery`, `vulnerability`, `build`, `image`, `package`, `deployment`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
69
81
  # @!attribute [rw] attestation
70
82
  # @return [::Grafeas::V1::AttestationOccurrence]
71
83
  # Describes an attestation of an artifact.
84
+ #
85
+ # Note: The following fields are mutually exclusive: `attestation`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `upgrade`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
72
86
  # @!attribute [rw] upgrade
73
87
  # @return [::Grafeas::V1::UpgradeOccurrence]
74
88
  # Describes an available package upgrade on the linked resource.
89
+ #
90
+ # Note: The following fields are mutually exclusive: `upgrade`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
75
91
  # @!attribute [rw] compliance
76
92
  # @return [::Grafeas::V1::ComplianceOccurrence]
77
93
  # Describes a compliance violation on a linked resource.
94
+ #
95
+ # Note: The following fields are mutually exclusive: `compliance`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
78
96
  # @!attribute [rw] dsse_attestation
79
97
  # @return [::Grafeas::V1::DSSEAttestationOccurrence]
80
98
  # Describes an attestation of an artifact using dsse.
99
+ #
100
+ # Note: The following fields are mutually exclusive: `dsse_attestation`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
81
101
  # @!attribute [rw] sbom_reference
82
102
  # @return [::Grafeas::V1::SBOMReferenceOccurrence]
83
103
  # Describes a specific SBOM reference occurrences.
104
+ #
105
+ # Note: The following fields are mutually exclusive: `sbom_reference`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
84
106
  # @!attribute [rw] envelope
85
107
  # @return [::Grafeas::V1::Envelope]
86
108
  # https://github.com/secure-systems-lab/dsse
@@ -124,39 +146,63 @@ module Grafeas
124
146
  # @!attribute [rw] vulnerability
125
147
  # @return [::Grafeas::V1::VulnerabilityNote]
126
148
  # A note describing a package vulnerability.
149
+ #
150
+ # Note: The following fields are mutually exclusive: `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
127
151
  # @!attribute [rw] build
128
152
  # @return [::Grafeas::V1::BuildNote]
129
153
  # A note describing build provenance for a verifiable build.
154
+ #
155
+ # Note: The following fields are mutually exclusive: `build`, `vulnerability`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
130
156
  # @!attribute [rw] image
131
157
  # @return [::Grafeas::V1::ImageNote]
132
158
  # A note describing a base image.
159
+ #
160
+ # Note: The following fields are mutually exclusive: `image`, `vulnerability`, `build`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
133
161
  # @!attribute [rw] package
134
162
  # @return [::Grafeas::V1::PackageNote]
135
163
  # A note describing a package hosted by various package managers.
164
+ #
165
+ # Note: The following fields are mutually exclusive: `package`, `vulnerability`, `build`, `image`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
136
166
  # @!attribute [rw] deployment
137
167
  # @return [::Grafeas::V1::DeploymentNote]
138
168
  # A note describing something that can be deployed.
169
+ #
170
+ # Note: The following fields are mutually exclusive: `deployment`, `vulnerability`, `build`, `image`, `package`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
139
171
  # @!attribute [rw] discovery
140
172
  # @return [::Grafeas::V1::DiscoveryNote]
141
173
  # A note describing the initial analysis of a resource.
174
+ #
175
+ # Note: The following fields are mutually exclusive: `discovery`, `vulnerability`, `build`, `image`, `package`, `deployment`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
142
176
  # @!attribute [rw] attestation
143
177
  # @return [::Grafeas::V1::AttestationNote]
144
178
  # A note describing an attestation role.
179
+ #
180
+ # Note: The following fields are mutually exclusive: `attestation`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `upgrade`, `compliance`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
145
181
  # @!attribute [rw] upgrade
146
182
  # @return [::Grafeas::V1::UpgradeNote]
147
183
  # A note describing available package upgrades.
184
+ #
185
+ # Note: The following fields are mutually exclusive: `upgrade`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `compliance`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
148
186
  # @!attribute [rw] compliance
149
187
  # @return [::Grafeas::V1::ComplianceNote]
150
188
  # A note describing a compliance check.
189
+ #
190
+ # Note: The following fields are mutually exclusive: `compliance`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `dsse_attestation`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
151
191
  # @!attribute [rw] dsse_attestation
152
192
  # @return [::Grafeas::V1::DSSEAttestationNote]
153
193
  # A note describing a dsse attestation note.
194
+ #
195
+ # Note: The following fields are mutually exclusive: `dsse_attestation`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `vulnerability_assessment`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
154
196
  # @!attribute [rw] vulnerability_assessment
155
197
  # @return [::Grafeas::V1::VulnerabilityAssessmentNote]
156
198
  # A note describing a vulnerability assessment.
199
+ #
200
+ # Note: The following fields are mutually exclusive: `vulnerability_assessment`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `sbom_reference`. If a field in that set is populated, all other fields in the set will automatically be cleared.
157
201
  # @!attribute [rw] sbom_reference
158
202
  # @return [::Grafeas::V1::SBOMReferenceNote]
159
203
  # A note describing an SBOM reference.
204
+ #
205
+ # Note: The following fields are mutually exclusive: `sbom_reference`, `vulnerability`, `build`, `image`, `package`, `deployment`, `discovery`, `attestation`, `upgrade`, `compliance`, `dsse_attestation`, `vulnerability_assessment`. If a field in that set is populated, all other fields in the set will automatically be cleared.
160
206
  class Note
161
207
  include ::Google::Protobuf::MessageExts
162
208
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -33,10 +33,13 @@ module Grafeas
33
33
  # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
34
34
  # @!attribute [rw] provenance
35
35
  # @return [::Grafeas::V1::InTotoProvenance]
36
+ # Note: The following fields are mutually exclusive: `provenance`, `slsa_provenance`, `slsa_provenance_zero_two`. If a field in that set is populated, all other fields in the set will automatically be cleared.
36
37
  # @!attribute [rw] slsa_provenance
37
38
  # @return [::Grafeas::V1::SlsaProvenance]
39
+ # Note: The following fields are mutually exclusive: `slsa_provenance`, `provenance`, `slsa_provenance_zero_two`. If a field in that set is populated, all other fields in the set will automatically be cleared.
38
40
  # @!attribute [rw] slsa_provenance_zero_two
39
41
  # @return [::Grafeas::V1::SlsaProvenanceZeroTwo]
42
+ # Note: The following fields are mutually exclusive: `slsa_provenance_zero_two`, `provenance`, `slsa_provenance`. If a field in that set is populated, all other fields in the set will automatically be cleared.
40
43
  class InTotoStatement
41
44
  include ::Google::Protobuf::MessageExts
42
45
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -190,12 +190,18 @@ module Grafeas
190
190
  # @!attribute [rw] cloud_repo
191
191
  # @return [::Grafeas::V1::CloudRepoSourceContext]
192
192
  # A SourceContext referring to a revision in a Google Cloud Source Repo.
193
+ #
194
+ # Note: The following fields are mutually exclusive: `cloud_repo`, `gerrit`, `git`. If a field in that set is populated, all other fields in the set will automatically be cleared.
193
195
  # @!attribute [rw] gerrit
194
196
  # @return [::Grafeas::V1::GerritSourceContext]
195
197
  # A SourceContext referring to a Gerrit project.
198
+ #
199
+ # Note: The following fields are mutually exclusive: `gerrit`, `cloud_repo`, `git`. If a field in that set is populated, all other fields in the set will automatically be cleared.
196
200
  # @!attribute [rw] git
197
201
  # @return [::Grafeas::V1::GitSourceContext]
198
202
  # A SourceContext referring to any third party Git repo (e.g., GitHub).
203
+ #
204
+ # Note: The following fields are mutually exclusive: `git`, `cloud_repo`, `gerrit`. If a field in that set is populated, all other fields in the set will automatically be cleared.
199
205
  # @!attribute [rw] labels
200
206
  # @return [::Google::Protobuf::Map{::String => ::String}]
201
207
  # Labels with user defined metadata.
@@ -249,9 +255,13 @@ module Grafeas
249
255
  # @!attribute [rw] revision_id
250
256
  # @return [::String]
251
257
  # A revision ID.
258
+ #
259
+ # Note: The following fields are mutually exclusive: `revision_id`, `alias_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
252
260
  # @!attribute [rw] alias_context
253
261
  # @return [::Grafeas::V1::AliasContext]
254
262
  # An alias, which may be a branch or tag.
263
+ #
264
+ # Note: The following fields are mutually exclusive: `alias_context`, `revision_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
255
265
  class CloudRepoSourceContext
256
266
  include ::Google::Protobuf::MessageExts
257
267
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -269,9 +279,13 @@ module Grafeas
269
279
  # @!attribute [rw] revision_id
270
280
  # @return [::String]
271
281
  # A revision (commit) ID.
282
+ #
283
+ # Note: The following fields are mutually exclusive: `revision_id`, `alias_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
272
284
  # @!attribute [rw] alias_context
273
285
  # @return [::Grafeas::V1::AliasContext]
274
286
  # An alias, which may be a branch or tag.
287
+ #
288
+ # Note: The following fields are mutually exclusive: `alias_context`, `revision_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
275
289
  class GerritSourceContext
276
290
  include ::Google::Protobuf::MessageExts
277
291
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -294,9 +308,13 @@ module Grafeas
294
308
  # @!attribute [rw] project_repo_id
295
309
  # @return [::Grafeas::V1::ProjectRepoId]
296
310
  # A combination of a project ID and a repo name.
311
+ #
312
+ # Note: The following fields are mutually exclusive: `project_repo_id`, `uid`. If a field in that set is populated, all other fields in the set will automatically be cleared.
297
313
  # @!attribute [rw] uid
298
314
  # @return [::String]
299
315
  # A server-assigned, globally unique identifier.
316
+ #
317
+ # Note: The following fields are mutually exclusive: `uid`, `project_repo_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
300
318
  class RepoId
301
319
  include ::Google::Protobuf::MessageExts
302
320
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: grafeas-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.1
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-08-30 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.21.1
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.21.1
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -121,7 +120,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
121
120
  licenses:
122
121
  - Apache-2.0
123
122
  metadata: {}
124
- post_install_message:
125
123
  rdoc_options: []
126
124
  require_paths:
127
125
  - lib
@@ -129,15 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
129
127
  requirements:
130
128
  - - ">="
131
129
  - !ruby/object:Gem::Version
132
- version: '2.7'
130
+ version: '3.0'
133
131
  required_rubygems_version: !ruby/object:Gem::Requirement
134
132
  requirements:
135
133
  - - ">="
136
134
  - !ruby/object:Gem::Version
137
135
  version: '0'
138
136
  requirements: []
139
- rubygems_version: 3.5.6
140
- signing_key:
137
+ rubygems_version: 3.6.2
141
138
  specification_version: 4
142
139
  summary: An implementation of the Grafeas API, which stores, and enables querying
143
140
  and retrieval of critical metadata about all of your software artifacts.