Skip to content

Commit f1ecb80

Browse files
dshelbyodshelbyo
authored
Merge pull request #152 from oracle/release_2019-02-21
Releasing GO SDK 4.0.0
2 parents c50779a + b1ed738 commit f1ecb80

File tree

63 files changed

+2693
-197
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+2693
-197
lines changed

‎CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](http://keepachangelog.com/)
66

7+
## 4.0.0 - 2019-02-21
8+
### Added
9+
- Support for government-realm regions
10+
- Support for the Streaming service
11+
- Support for tags in the Key Management service
12+
- Support for regional subnets in the Virtual Networking service
13+
14+
### Fixed
15+
- Removed unused Announcements service 'NotificationFollowupDetails' struct and 'GetFollowups' operation
16+
- InstancePrincipals now invalidates a token shortly before its expiration time to avoid making a service call with an expired token
17+
- Requests with binary bodies that require its body to be included in the signature are now being signed correctly
18+
719
## 3.7.0 - 2019-02-07
820
### Added
921
- Support for the Web Application Acceleration and Security (WAAS) service

‎Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
DOC_SERVER_URL=https:\/\/docs.us-phoenix-1.oraclecloud.com
22

3-
GEN_TARGETS = identity core objectstorage loadbalancer database audit dns filestorage email containerengine resourcesearch keymanagement announcementsservice healthchecks waas ##SPECNAME##
3+
GEN_TARGETS = identity core objectstorage loadbalancer database audit dns filestorage email containerengine resourcesearch keymanagement announcementsservice healthchecks waas streaming ##SPECNAME##
44
NON_GEN_TARGETS = common common/auth
55
TARGETS = $(NON_GEN_TARGETS) $(GEN_TARGETS)
66

‎announcementsservice/affected_resource.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// Announcements Service API
55
//
6-
// A description of the AnnouncementsService API
6+
// Manage Oracle Cloud Infrastructure console announcements.
77
//
88

99
package announcementsservice
@@ -12,16 +12,16 @@ import (
1212
"github.com/oracle/oci-go-sdk/common"
1313
)
1414

15-
// AffectedResource Descrption of a resource affected by the announcement
15+
// AffectedResource The resource affected by the event described in the announcement.
1616
type AffectedResource struct {
1717

18-
// The OCID of the resource
18+
// The OCID of the affected resource.
1919
ResourceId *string `mandatory:"true" json:"resourceId"`
2020

21-
// User-friendly name of the resource
21+
// The friendly name of the resource.
2222
ResourceName *string `mandatory:"true" json:"resourceName"`
2323

24-
// Region where this resource belongs to
24+
// The region where the affected resource exists.
2525
Region *string `mandatory:"true" json:"region"`
2626
}
2727

‎announcementsservice/announcement.go

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// Announcements Service API
55
//
6-
// A description of the AnnouncementsService API
6+
// Manage Oracle Cloud Infrastructure console announcements.
77
//
88

99
package announcementsservice
@@ -13,62 +13,68 @@ import (
1313
"github.com/oracle/oci-go-sdk/common"
1414
)
1515

16-
// Announcement An announcement object which represents a message targetted to a specific tenant
16+
// Announcement A message about an impactful operational event.
1717
type Announcement struct {
1818

19-
// The OCID of the announcement
19+
// The OCID of the announcement.
2020
Id *string `mandatory:"true" json:"id"`
2121

22-
// The reference JIRA ticket number
22+
// The reference Jira ticket number.
2323
ReferenceTicketNumber *string `mandatory:"true" json:"referenceTicketNumber"`
2424

25-
// Forms part of the email subject and/or the console representation (a banner or alike)
25+
// A summary of the issue. A summary might appear in the console banner view of the announcement or in
26+
// an email subject line. Avoid entering confidential information.
2627
Summary *string `mandatory:"true" json:"summary"`
2728

28-
// Show announcement as a banner
29+
// Impacted Oracle Cloud Infrastructure services.
30+
Services []string `mandatory:"true" json:"services"`
31+
32+
// Impacted regions.
33+
AffectedRegions []string `mandatory:"true" json:"affectedRegions"`
34+
35+
// Whether the announcement is displayed as a banner in the console.
2936
IsBanner *bool `mandatory:"true" json:"isBanner"`
3037

31-
// The title of the first time value, e.g. Time Started
38+
// The label associated with an initial time value.
39+
// Example: `Time Started`
3240
TimeOneTitle *string `mandatory:"false" json:"timeOneTitle"`
3341

34-
// The first time value, actual meaning depending on notification type
42+
// The actual value of the first time value for the event. Typically, this is the time an event started, but the meaning
43+
// can vary, depending on the announcement type.
3544
TimeOneValue *common.SDKTime `mandatory:"false" json:"timeOneValue"`
3645

37-
// The title of the second time value, e.g. Time Ended
46+
// The label associated with a second time value.
47+
// Example: `Time Ended`
3848
TimeTwoTitle *string `mandatory:"false" json:"timeTwoTitle"`
3949

40-
// The second time value, actual meaning depending on notification type
50+
// The actual value of the second time value. Typically, this is the time an event ended, but the meaning
51+
// can vary, depending on the announcement type.
4152
TimeTwoValue *common.SDKTime `mandatory:"false" json:"timeTwoValue"`
4253

43-
// Impacted services
44-
Services []string `mandatory:"false" json:"services"`
45-
46-
// Impacted regions
47-
AffectedRegions []string `mandatory:"false" json:"affectedRegions"`
48-
49-
// The date and time the announcement was created, in the format defined by RFC3339
50-
// Example: `2016-07-22T17:43:01.389+0000`
54+
// The date and time the announcement was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
55+
// Example: `2019-01-01T17:43:01.389+0000`
5156
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
5257

53-
// The date and time the announcement was last updated, in the format defined by RFC3339
54-
// Example: `2016-07-22T17:43:01.389+0000`
58+
// The date and time the announcement was last updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
59+
// Example: `2019-01-01T17:43:01.389+0000`
5560
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
5661

57-
// A more detailed explanation of the notification. A markdown format input
62+
// A detailed explanation of the event, expressed by using Markdown language. Avoid entering
63+
// confidential information.
5864
Description *string `mandatory:"false" json:"description"`
5965

60-
// A markdown format input that forms e.g. the FAQ section of a notification
66+
// Additional information about the event, expressed by using Markdown language and included in the
67+
// details view of an announcement. Additional information might include remediation steps or
68+
// answers to frequently asked questions. Avoid entering confidential information.
6169
AdditionalInformation *string `mandatory:"false" json:"additionalInformation"`
6270

63-
Followups []NotificationFollowupDetails `mandatory:"false" json:"followups"`
64-
65-
// List of resources (possibly empty) affected by this announcement
71+
// The list of resources, if any, affected by the event described in the announcement.
6672
AffectedResources []AffectedResource `mandatory:"false" json:"affectedResources"`
6773

68-
// The detailed description of an announcement
74+
// The type of announcement. An announcement's type signals its severity.
6975
AnnouncementType BaseAnnouncementAnnouncementTypeEnum `mandatory:"true" json:"announcementType"`
7076

71-
// Lifecycle states of announcement
77+
// The current lifecycle state of the announcement.
7278
LifecycleState BaseAnnouncementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
7379
}
7480

‎announcementsservice/announcement_summary.go

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// Announcements Service API
55
//
6-
// A description of the AnnouncementsService API
6+
// Manage Oracle Cloud Infrastructure console announcements.
77
//
88

99
package announcementsservice
@@ -13,51 +13,56 @@ import (
1313
"github.com/oracle/oci-go-sdk/common"
1414
)
1515

16-
// AnnouncementSummary An announcement summary object which is returned by List API
16+
// AnnouncementSummary Summary representation of an announcement.
1717
type AnnouncementSummary struct {
1818

19-
// The OCID of the announcement
19+
// The OCID of the announcement.
2020
Id *string `mandatory:"true" json:"id"`
2121

22-
// The reference JIRA ticket number
22+
// The reference Jira ticket number.
2323
ReferenceTicketNumber *string `mandatory:"true" json:"referenceTicketNumber"`
2424

25-
// Forms part of the email subject and/or the console representation (a banner or alike)
25+
// A summary of the issue. A summary might appear in the console banner view of the announcement or in
26+
// an email subject line. Avoid entering confidential information.
2627
Summary *string `mandatory:"true" json:"summary"`
2728

28-
// Show announcement as a banner
29+
// Impacted Oracle Cloud Infrastructure services.
30+
Services []string `mandatory:"true" json:"services"`
31+
32+
// Impacted regions.
33+
AffectedRegions []string `mandatory:"true" json:"affectedRegions"`
34+
35+
// Whether the announcement is displayed as a banner in the console.
2936
IsBanner *bool `mandatory:"true" json:"isBanner"`
3037

31-
// The title of the first time value, e.g. Time Started
38+
// The label associated with an initial time value.
39+
// Example: `Time Started`
3240
TimeOneTitle *string `mandatory:"false" json:"timeOneTitle"`
3341

34-
// The first time value, actual meaning depending on notification type
42+
// The actual value of the first time value for the event. Typically, this is the time an event started, but the meaning
43+
// can vary, depending on the announcement type.
3544
TimeOneValue *common.SDKTime `mandatory:"false" json:"timeOneValue"`
3645

37-
// The title of the second time value, e.g. Time Ended
46+
// The label associated with a second time value.
47+
// Example: `Time Ended`
3848
TimeTwoTitle *string `mandatory:"false" json:"timeTwoTitle"`
3949

40-
// The second time value, actual meaning depending on notification type
50+
// The actual value of the second time value. Typically, this is the time an event ended, but the meaning
51+
// can vary, depending on the announcement type.
4152
TimeTwoValue *common.SDKTime `mandatory:"false" json:"timeTwoValue"`
4253

43-
// Impacted services
44-
Services []string `mandatory:"false" json:"services"`
45-
46-
// Impacted regions
47-
AffectedRegions []string `mandatory:"false" json:"affectedRegions"`
48-
49-
// The date and time the announcement was created, in the format defined by RFC3339
50-
// Example: `2016-07-22T17:43:01.389+0000`
54+
// The date and time the announcement was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
55+
// Example: `2019-01-01T17:43:01.389+0000`
5156
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
5257

53-
// The date and time the announcement was last updated, in the format defined by RFC3339
54-
// Example: `2016-07-22T17:43:01.389+0000`
58+
// The date and time the announcement was last updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
59+
// Example: `2019-01-01T17:43:01.389+0000`
5560
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
5661

57-
// The detailed description of an announcement
62+
// The type of announcement. An announcement's type signals its severity.
5863
AnnouncementType BaseAnnouncementAnnouncementTypeEnum `mandatory:"true" json:"announcementType"`
5964

60-
// Lifecycle states of announcement
65+
// The current lifecycle state of the announcement.
6166
LifecycleState BaseAnnouncementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
6267
}
6368

‎announcementsservice/announcement_user_status_details.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// Announcements Service API
55
//
6-
// A description of the AnnouncementsService API
6+
// Manage Oracle Cloud Infrastructure console announcements.
77
//
88

99
package announcementsservice
@@ -12,17 +12,17 @@ import (
1212
"github.com/oracle/oci-go-sdk/common"
1313
)
1414

15-
// AnnouncementUserStatusDetails An announcement status
15+
// AnnouncementUserStatusDetails An announcement's status regarding whether it has been acknowledged by a user.
1616
type AnnouncementUserStatusDetails struct {
1717

18-
// The OCID of the announcement this status belongs to
18+
// The OCID of the announcement that this status is associated with.
1919
UserStatusAnnouncementId *string `mandatory:"true" json:"userStatusAnnouncementId"`
2020

21-
// The OCID of the user this status belongs to
21+
// The OCID of the user that this status is associated with.
2222
UserId *string `mandatory:"true" json:"userId"`
2323

24-
// The date and time the announcement was acknowledged, in the format defined by RFC3339
25-
// Example: `2016-07-22T17:43:01.389+0000`
24+
// The date and time the announcement was acknowledged, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
25+
// Example: `2019-01-01T17:43:01.389+0000`
2626
TimeAcknowledged *common.SDKTime `mandatory:"false" json:"timeAcknowledged"`
2727
}
2828

‎announcementsservice/announcements_collection.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// Announcements Service API
55
//
6-
// A description of the AnnouncementsService API
6+
// Manage Oracle Cloud Infrastructure console announcements.
77
//
88

99
package announcementsservice
@@ -12,13 +12,13 @@ import (
1212
"github.com/oracle/oci-go-sdk/common"
1313
)
1414

15-
// AnnouncementsCollection Results of annoucements search. Contains both announcements, and user specific status of the announcments
15+
// AnnouncementsCollection A list of announcements that match filter criteria, if any. Results contain both the announcements and the user-specific status of the announcements.
1616
type AnnouncementsCollection struct {
1717

18-
// collection of announcements
18+
// A collection of announcements.
1919
Items []AnnouncementSummary `mandatory:"false" json:"items"`
2020

21-
// user specific status of found announcements
21+
// The user-specific status for found announcements.
2222
UserStatuses []AnnouncementUserStatusDetails `mandatory:"false" json:"userStatuses"`
2323
}
2424

‎announcementsservice/announcementsservice_announcement_client.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
// Announcements Service API
55
//
6-
// A description of the AnnouncementsService API
6+
// Manage Oracle Cloud Infrastructure console announcements.
77
//
88

99
package announcementsservice
@@ -58,7 +58,7 @@ func (client *AnnouncementClient) ConfigurationProvider() *common.ConfigurationP
5858
return client.config
5959
}
6060

61-
// GetAnnouncement Gets details about single `Announcement` object
61+
// GetAnnouncement Gets the details of a specific announcement.
6262
func (client AnnouncementClient) GetAnnouncement(ctx context.Context, request GetAnnouncementRequest) (response GetAnnouncementResponse, err error) {
6363
var ociResponse common.OCIResponse
6464
policy := common.NoRetryPolicy()
@@ -100,7 +100,7 @@ func (client AnnouncementClient) getAnnouncement(ctx context.Context, request co
100100
return response, err
101101
}
102102

103-
// GetAnnouncementUserStatus Get user status of specified announcement
103+
// GetAnnouncementUserStatus Gets information about whether a specific announcement was acknowledged by a user.
104104
func (client AnnouncementClient) GetAnnouncementUserStatus(ctx context.Context, request GetAnnouncementUserStatusRequest) (response GetAnnouncementUserStatusResponse, err error) {
105105
var ociResponse common.OCIResponse
106106
policy := common.NoRetryPolicy()
@@ -142,7 +142,7 @@ func (client AnnouncementClient) getAnnouncementUserStatus(ctx context.Context,
142142
return response, err
143143
}
144144

145-
// ListAnnouncements Gets a list of `Announcement` objects for the current tenancy
145+
// ListAnnouncements Gets a list of announcements for the current tenancy.
146146
func (client AnnouncementClient) ListAnnouncements(ctx context.Context, request ListAnnouncementsRequest) (response ListAnnouncementsResponse, err error) {
147147
var ociResponse common.OCIResponse
148148
policy := common.NoRetryPolicy()
@@ -184,7 +184,7 @@ func (client AnnouncementClient) listAnnouncements(ctx context.Context, request
184184
return response, err
185185
}
186186

187-
// UpdateAnnouncementUserStatus Update `Announcement` status with whether user has seen or supressed the announcement
187+
// UpdateAnnouncementUserStatus Updates the status of the specified announcement with regard to whether it has been marked as read.
188188
func (client AnnouncementClient) UpdateAnnouncementUserStatus(ctx context.Context, request UpdateAnnouncementUserStatusRequest) (response UpdateAnnouncementUserStatusResponse, err error) {
189189
var ociResponse common.OCIResponse
190190
policy := common.NoRetryPolicy()

0 commit comments

Comments
 (0)